blob: 3d80e4267de83f3fae3e3aedf611ad1b3dbd3e2a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Comtrol SV11 card driver
3 *
4 * This is a slightly odd Z85230 synchronous driver. All you need to
5 * know basically is
6 *
7 * Its a genuine Z85230
8 *
9 * It supports DMA using two DMA channels in SYNC mode. The driver doesn't
10 * use these facilities
11 *
12 * The control port is at io+1, the data at io+3 and turning off the DMA
13 * is done by writing 0 to io+4
14 *
15 * The hardware does the bus handling to avoid the need for delays between
16 * touching control registers.
17 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -030018 * Port B isn't wired (why - beats me)
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020019 *
20 * Generic HDLC port Copyright (C) 2008 Krzysztof Halasa <khc@pm.waw.pl>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021 */
22
Joe Perches23efcb72011-06-26 19:01:35 +000023#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
24
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/module.h>
26#include <linux/kernel.h>
27#include <linux/mm.h>
28#include <linux/net.h>
29#include <linux/skbuff.h>
30#include <linux/netdevice.h>
31#include <linux/if_arp.h>
32#include <linux/delay.h>
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020033#include <linux/hdlc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/ioport.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090035#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <net/arp.h>
37
Al Viro82729972005-12-06 05:53:04 -050038#include <asm/irq.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070039#include <asm/io.h>
40#include <asm/dma.h>
41#include <asm/byteorder.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042#include "z85230.h"
43
44static int dma;
45
Linus Torvalds1da177e2005-04-16 15:20:36 -070046/*
47 * Network driver support routines
48 */
49
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020050static inline struct z8530_dev* dev_to_sv(struct net_device *dev)
51{
52 return (struct z8530_dev *)dev_to_hdlc(dev)->priv;
53}
54
Linus Torvalds1da177e2005-04-16 15:20:36 -070055/*
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020056 * Frame receive. Simple for our card as we do HDLC and there
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 * is no funny garbage involved
58 */
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020059
Linus Torvalds1da177e2005-04-16 15:20:36 -070060static void hostess_input(struct z8530_channel *c, struct sk_buff *skb)
61{
62 /* Drop the CRC - it's not a good idea to try and negotiate it ;) */
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020063 skb_trim(skb, skb->len - 2);
64 skb->protocol = hdlc_type_trans(skb, c->netdevice);
Arnaldo Carvalho de Melo98e399f2007-03-19 15:33:04 -070065 skb_reset_mac_header(skb);
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020066 skb->dev = c->netdevice;
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 /*
68 * Send it to the PPP layer. We don't have time to process
69 * it right now.
70 */
71 netif_rx(skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -070072}
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020073
Linus Torvalds1da177e2005-04-16 15:20:36 -070074/*
75 * We've been placed in the UP state
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020076 */
77
Linus Torvalds1da177e2005-04-16 15:20:36 -070078static int hostess_open(struct net_device *d)
79{
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020080 struct z8530_dev *sv11 = dev_to_sv(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 int err = -1;
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020082
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 /*
84 * Link layer up
85 */
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020086 switch (dma) {
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 case 0:
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020088 err = z8530_sync_open(d, &sv11->chanA);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 break;
90 case 1:
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020091 err = z8530_sync_dma_open(d, &sv11->chanA);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 break;
93 case 2:
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020094 err = z8530_sync_txdma_open(d, &sv11->chanA);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 break;
96 }
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +020097
98 if (err)
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 return err;
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200100
101 err = hdlc_open(d);
102 if (err) {
103 switch (dma) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 case 0:
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200105 z8530_sync_close(d, &sv11->chanA);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 break;
107 case 1:
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200108 z8530_sync_dma_close(d, &sv11->chanA);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 break;
110 case 2:
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200111 z8530_sync_txdma_close(d, &sv11->chanA);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 break;
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200113 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 return err;
115 }
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200116 sv11->chanA.rx_function = hostess_input;
117
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 /*
119 * Go go go
120 */
121
122 netif_start_queue(d);
123 return 0;
124}
125
126static int hostess_close(struct net_device *d)
127{
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200128 struct z8530_dev *sv11 = dev_to_sv(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 /*
130 * Discard new frames
131 */
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200132 sv11->chanA.rx_function = z8530_null_rx;
133
134 hdlc_close(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 netif_stop_queue(d);
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200136
137 switch (dma) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 case 0:
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200139 z8530_sync_close(d, &sv11->chanA);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 break;
141 case 1:
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200142 z8530_sync_dma_close(d, &sv11->chanA);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 break;
144 case 2:
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200145 z8530_sync_txdma_close(d, &sv11->chanA);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 break;
147 }
148 return 0;
149}
150
151static int hostess_ioctl(struct net_device *d, struct ifreq *ifr, int cmd)
152{
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200153 /* struct z8530_dev *sv11=dev_to_sv(d);
154 z8530_ioctl(d,&sv11->chanA,ifr,cmd) */
155 return hdlc_ioctl(d, ifr, cmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156}
157
158/*
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200159 * Passed network frames, fire them downwind.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 */
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200161
Stephen Hemmingerd71a6742009-08-31 19:50:47 +0000162static netdev_tx_t hostess_queue_xmit(struct sk_buff *skb,
163 struct net_device *d)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164{
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200165 return z8530_queue_xmit(&dev_to_sv(d)->chanA, skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166}
167
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200168static int hostess_attach(struct net_device *dev, unsigned short encoding,
169 unsigned short parity)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170{
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200171 if (encoding == ENCODING_NRZ && parity == PARITY_CRC16_PR1_CCITT)
172 return 0;
173 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174}
175
176/*
177 * Description block for a Comtrol Hostess SV11 card
178 */
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200179
Krzysztof Hałasa991990a2009-01-08 22:52:11 +0100180static const struct net_device_ops hostess_ops = {
181 .ndo_open = hostess_open,
182 .ndo_stop = hostess_close,
183 .ndo_change_mtu = hdlc_change_mtu,
184 .ndo_start_xmit = hdlc_start_xmit,
185 .ndo_do_ioctl = hostess_ioctl,
186};
187
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200188static struct z8530_dev *sv11_init(int iobase, int irq)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189{
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200190 struct z8530_dev *sv;
191 struct net_device *netdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 /*
193 * Get the needed I/O space
194 */
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200195
196 if (!request_region(iobase, 8, "Comtrol SV11")) {
Joe Perches23efcb72011-06-26 19:01:35 +0000197 pr_warn("I/O 0x%X already in use\n", iobase);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 return NULL;
199 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200201 sv = kzalloc(sizeof(struct z8530_dev), GFP_KERNEL);
202 if (!sv)
203 goto err_kzalloc;
204
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 /*
206 * Stuff in the I/O addressing
207 */
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200208
209 sv->active = 0;
210
211 sv->chanA.ctrlio = iobase + 1;
212 sv->chanA.dataio = iobase + 3;
213 sv->chanB.ctrlio = -1;
214 sv->chanB.dataio = -1;
215 sv->chanA.irqs = &z8530_nop;
216 sv->chanB.irqs = &z8530_nop;
217
218 outb(0, iobase + 4); /* DMA off */
219
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 /* We want a fast IRQ for this device. Actually we'd like an even faster
221 IRQ ;) - This is one driver RtLinux is made for */
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200222
Joe Perchesa0607fd2009-11-18 23:29:17 -0800223 if (request_irq(irq, z8530_interrupt, IRQF_DISABLED,
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200224 "Hostess SV11", sv) < 0) {
Joe Perches23efcb72011-06-26 19:01:35 +0000225 pr_warn("IRQ %d already in use\n", irq);
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200226 goto err_irq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 }
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200228
229 sv->irq = irq;
230 sv->chanA.private = sv;
231 sv->chanA.dev = sv;
232 sv->chanB.dev = sv;
233
234 if (dma) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235 /*
236 * You can have DMA off or 1 and 3 thats the lot
237 * on the Comtrol.
238 */
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200239 sv->chanA.txdma = 3;
240 sv->chanA.rxdma = 1;
241 outb(0x03 | 0x08, iobase + 4); /* DMA on */
242 if (request_dma(sv->chanA.txdma, "Hostess SV/11 (TX)"))
243 goto err_txdma;
244
245 if (dma == 1)
246 if (request_dma(sv->chanA.rxdma, "Hostess SV/11 (RX)"))
247 goto err_rxdma;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 }
249
250 /* Kill our private IRQ line the hostess can end up chattering
251 until the configuration is set */
252 disable_irq(irq);
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200253
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 /*
255 * Begin normal initialise
256 */
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200257
258 if (z8530_init(sv)) {
Joe Perches23efcb72011-06-26 19:01:35 +0000259 pr_err("Z8530 series device not found\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 enable_irq(irq);
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200261 goto free_dma;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 }
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200263 z8530_channel_load(&sv->chanB, z8530_dead_port);
264 if (sv->type == Z85C30)
265 z8530_channel_load(&sv->chanA, z8530_hdlc_kilostream);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 else
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200267 z8530_channel_load(&sv->chanA, z8530_hdlc_kilostream_85230);
268
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 enable_irq(irq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
271 /*
272 * Now we can take the IRQ
273 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200275 sv->chanA.netdevice = netdev = alloc_hdlcdev(sv);
276 if (!netdev)
277 goto free_dma;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200279 dev_to_hdlc(netdev)->attach = hostess_attach;
280 dev_to_hdlc(netdev)->xmit = hostess_queue_xmit;
Krzysztof Hałasa991990a2009-01-08 22:52:11 +0100281 netdev->netdev_ops = &hostess_ops;
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200282 netdev->base_addr = iobase;
283 netdev->irq = irq;
284
285 if (register_hdlc_device(netdev)) {
Joe Perches23efcb72011-06-26 19:01:35 +0000286 pr_err("unable to register HDLC device\n");
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200287 free_netdev(netdev);
288 goto free_dma;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 }
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200290
291 z8530_describe(sv, "I/O", iobase);
292 sv->active = 1;
293 return sv;
294
295free_dma:
296 if (dma == 1)
297 free_dma(sv->chanA.rxdma);
298err_rxdma:
299 if (dma)
300 free_dma(sv->chanA.txdma);
301err_txdma:
302 free_irq(irq, sv);
303err_irq:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 kfree(sv);
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200305err_kzalloc:
306 release_region(iobase, 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 return NULL;
308}
309
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200310static void sv11_shutdown(struct z8530_dev *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311{
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200312 unregister_hdlc_device(dev->chanA.netdevice);
313 z8530_shutdown(dev);
314 free_irq(dev->irq, dev);
315 if (dma) {
316 if (dma == 1)
317 free_dma(dev->chanA.rxdma);
318 free_dma(dev->chanA.txdma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 }
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200320 release_region(dev->chanA.ctrlio - 1, 8);
321 free_netdev(dev->chanA.netdevice);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 kfree(dev);
323}
324
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200325static int io = 0x200;
326static int irq = 9;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
328module_param(io, int, 0);
329MODULE_PARM_DESC(io, "The I/O base of the Comtrol Hostess SV11 card");
330module_param(dma, int, 0);
331MODULE_PARM_DESC(dma, "Set this to 1 to use DMA1/DMA3 for TX/RX");
332module_param(irq, int, 0);
333MODULE_PARM_DESC(irq, "The interrupt line setting for the Comtrol Hostess SV11 card");
334
335MODULE_AUTHOR("Alan Cox");
336MODULE_LICENSE("GPL");
337MODULE_DESCRIPTION("Modular driver for the Comtrol Hostess SV11");
338
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200339static struct z8530_dev *sv11_unit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
341int init_module(void)
342{
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200343 if ((sv11_unit = sv11_init(io, irq)) == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 return -ENODEV;
345 return 0;
346}
347
348void cleanup_module(void)
349{
Krzysztof Hałasa52e8a6a2008-07-02 17:47:52 +0200350 if (sv11_unit)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 sv11_shutdown(sv11_unit);
352}