[deliverable/linux.git] / drivers / net / wan / hostess_sv11.c

/*
 *	Comtrol SV11 card driver
 *
 *	This is a slightly odd Z85230 synchronous driver. All you need to
 *	know basically is
 *
 *	Its a genuine Z85230
 *
 *	It supports DMA using two DMA channels in SYNC mode. The driver doesn't
 *	use these facilities
 *	
 *	The control port is at io+1, the data at io+3 and turning off the DMA
 *	is done by writing 0 to io+4
 *
 *	The hardware does the bus handling to avoid the need for delays between
 *	touching control registers.
 *
 *	Port B isn't wired (why - beats me)
 *
 *	Generic HDLC port Copyright (C) 2008 Krzysztof Halasa <khc@pm.waw.pl>
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/mm.h>
#include <linux/net.h>
#include <linux/skbuff.h>
#include <linux/netdevice.h>
#include <linux/if_arp.h>
#include <linux/delay.h>
#include <linux/hdlc.h>
#include <linux/ioport.h>
#include <linux/slab.h>
#include <net/arp.h>

#include <asm/irq.h>
#include <asm/io.h>
#include <asm/dma.h>
#include <asm/byteorder.h>
#include "z85230.h"

static int dma;

/*
 *	Network driver support routines
 */

static inline struct z8530_dev* dev_to_sv(struct net_device *dev)
{
	return (struct z8530_dev *)dev_to_hdlc(dev)->priv;
}

/*
 *	Frame receive. Simple for our card as we do HDLC and there
 *	is no funny garbage involved
 */

static void hostess_input(struct z8530_channel *c, struct sk_buff *skb)
{
	/* Drop the CRC - it's not a good idea to try and negotiate it ;) */
	skb_trim(skb, skb->len - 2);
	skb->protocol = hdlc_type_trans(skb, c->netdevice);
	skb_reset_mac_header(skb);
	skb->dev = c->netdevice;
	/*
	 *	Send it to the PPP layer. We don't have time to process
	 *	it right now.
	 */
	netif_rx(skb);
}

/*
 *	We've been placed in the UP state
 */

static int hostess_open(struct net_device *d)
{
	struct z8530_dev *sv11 = dev_to_sv(d);
	int err = -1;

	/*
	 *	Link layer up
	 */
	switch (dma) {
		case 0:
			err = z8530_sync_open(d, &sv11->chanA);
			break;
		case 1:
			err = z8530_sync_dma_open(d, &sv11->chanA);
			break;
		case 2:
			err = z8530_sync_txdma_open(d, &sv11->chanA);
			break;
	}

	if (err)
		return err;

	err = hdlc_open(d);
	if (err) {
		switch (dma) {
			case 0:
				z8530_sync_close(d, &sv11->chanA);
				break;
			case 1:
				z8530_sync_dma_close(d, &sv11->chanA);
				break;
			case 2:
				z8530_sync_txdma_close(d, &sv11->chanA);
				break;
		}
		return err;
	}
	sv11->chanA.rx_function = hostess_input;

	/*
	 *	Go go go
	 */

	netif_start_queue(d);
	return 0;
}

static int hostess_close(struct net_device *d)
{
	struct z8530_dev *sv11 = dev_to_sv(d);
	/*
	 *	Discard new frames
	 */
	sv11->chanA.rx_function = z8530_null_rx;

	hdlc_close(d);
	netif_stop_queue(d);

	switch (dma) {
		case 0:
			z8530_sync_close(d, &sv11->chanA);
			break;
		case 1:
			z8530_sync_dma_close(d, &sv11->chanA);
			break;
		case 2:
			z8530_sync_txdma_close(d, &sv11->chanA);
			break;
	}
	return 0;
}

static int hostess_ioctl(struct net_device *d, struct ifreq *ifr, int cmd)
{
	/* struct z8530_dev *sv11=dev_to_sv(d);
	   z8530_ioctl(d,&sv11->chanA,ifr,cmd) */
	return hdlc_ioctl(d, ifr, cmd);
}

/*
 *	Passed network frames, fire them downwind.
 */

static netdev_tx_t hostess_queue_xmit(struct sk_buff *skb,
					    struct net_device *d)
{
	return z8530_queue_xmit(&dev_to_sv(d)->chanA, skb);
}

static int hostess_attach(struct net_device *dev, unsigned short encoding,
			  unsigned short parity)
{
	if (encoding == ENCODING_NRZ && parity == PARITY_CRC16_PR1_CCITT)
		return 0;
	return -EINVAL;
}

/*
 *	Description block for a Comtrol Hostess SV11 card
 */

static const struct net_device_ops hostess_ops = {
	.ndo_open       = hostess_open,
	.ndo_stop       = hostess_close,
	.ndo_change_mtu = hdlc_change_mtu,
	.ndo_start_xmit = hdlc_start_xmit,
	.ndo_do_ioctl   = hostess_ioctl,
};

static struct z8530_dev *sv11_init(int iobase, int irq)
{
	struct z8530_dev *sv;
	struct net_device *netdev;
	/*
	 *	Get the needed I/O space
	 */

	if (!request_region(iobase, 8, "Comtrol SV11")) {
		pr_warn("I/O 0x%X already in use\n", iobase);
		return NULL;
	}

	sv = kzalloc(sizeof(struct z8530_dev), GFP_KERNEL);
	if (!sv)
		goto err_kzalloc;

	/*
	 *	Stuff in the I/O addressing
	 */

	sv->active = 0;

	sv->chanA.ctrlio = iobase + 1;
	sv->chanA.dataio = iobase + 3;
	sv->chanB.ctrlio = -1;
	sv->chanB.dataio = -1;
	sv->chanA.irqs = &z8530_nop;
	sv->chanB.irqs = &z8530_nop;

	outb(0, iobase + 4);		/* DMA off */

	/* We want a fast IRQ for this device. Actually we'd like an even faster
	   IRQ ;) - This is one driver RtLinux is made for */

	if (request_irq(irq, z8530_interrupt, 0,
			"Hostess SV11", sv) < 0) {
		pr_warn("IRQ %d already in use\n", irq);
		goto err_irq;
	}

	sv->irq = irq;
	sv->chanA.private = sv;
	sv->chanA.dev = sv;
	sv->chanB.dev = sv;

	if (dma) {
		/*
		 *	You can have DMA off or 1 and 3 thats the lot
		 *	on the Comtrol.
		 */
		sv->chanA.txdma = 3;
		sv->chanA.rxdma = 1;
		outb(0x03 | 0x08, iobase + 4);		/* DMA on */
		if (request_dma(sv->chanA.txdma, "Hostess SV/11 (TX)"))
			goto err_txdma;

		if (dma == 1)
			if (request_dma(sv->chanA.rxdma, "Hostess SV/11 (RX)"))
				goto err_rxdma;
	}

	/* Kill our private IRQ line the hostess can end up chattering
	   until the configuration is set */
	disable_irq(irq);

	/*
	 *	Begin normal initialise
	 */

	if (z8530_init(sv)) {
		pr_err("Z8530 series device not found\n");
		enable_irq(irq);
		goto free_dma;
	}
	z8530_channel_load(&sv->chanB, z8530_dead_port);
	if (sv->type == Z85C30)
		z8530_channel_load(&sv->chanA, z8530_hdlc_kilostream);
	else
		z8530_channel_load(&sv->chanA, z8530_hdlc_kilostream_85230);

	enable_irq(irq);

	/*
	 *	Now we can take the IRQ
	 */

	sv->chanA.netdevice = netdev = alloc_hdlcdev(sv);
	if (!netdev)
		goto free_dma;

	dev_to_hdlc(netdev)->attach = hostess_attach;
	dev_to_hdlc(netdev)->xmit = hostess_queue_xmit;
	netdev->netdev_ops = &hostess_ops;
	netdev->base_addr = iobase;
	netdev->irq = irq;

	if (register_hdlc_device(netdev)) {
		pr_err("unable to register HDLC device\n");
		free_netdev(netdev);
		goto free_dma;
	}

	z8530_describe(sv, "I/O", iobase);
	sv->active = 1;
	return sv;

free_dma:
	if (dma == 1)
		free_dma(sv->chanA.rxdma);
err_rxdma:
	if (dma)
		free_dma(sv->chanA.txdma);
err_txdma:
	free_irq(irq, sv);
err_irq:
	kfree(sv);
err_kzalloc:
	release_region(iobase, 8);
	return NULL;
}

static void sv11_shutdown(struct z8530_dev *dev)
{
	unregister_hdlc_device(dev->chanA.netdevice);
	z8530_shutdown(dev);
	free_irq(dev->irq, dev);
	if (dma) {
		if (dma == 1)
			free_dma(dev->chanA.rxdma);
		free_dma(dev->chanA.txdma);
	}
	release_region(dev->chanA.ctrlio - 1, 8);
	free_netdev(dev->chanA.netdevice);
	kfree(dev);
}

static int io = 0x200;
static int irq = 9;

module_param(io, int, 0);
MODULE_PARM_DESC(io, "The I/O base of the Comtrol Hostess SV11 card");
module_param(dma, int, 0);
MODULE_PARM_DESC(dma, "Set this to 1 to use DMA1/DMA3 for TX/RX");
module_param(irq, int, 0);
MODULE_PARM_DESC(irq, "The interrupt line setting for the Comtrol Hostess SV11 card");

MODULE_AUTHOR("Alan Cox");
MODULE_LICENSE("GPL");
MODULE_DESCRIPTION("Modular driver for the Comtrol Hostess SV11");

static struct z8530_dev *sv11_unit;

int init_module(void)
{
	if ((sv11_unit = sv11_init(io, irq)) == NULL)
		return -ENODEV;
	return 0;
}

void cleanup_module(void)
{
	if (sv11_unit)
		sv11_shutdown(sv11_unit);
}
Commit	Line	Data
1da177e4 LT	1	/*
	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	*
25985edc	18	* Port B isn't wired (why - beats me)
52e8a6a2 KH	19	*
52e8a6a2 KH	20	* Generic HDLC port Copyright (C) 2008 Krzysztof Halasa <khc@pm.waw.pl>
1da177e4 LT	21	*/
1da177e4 LT	22
23efcb73 JP	23	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
23efcb73 JP	24
1da177e4 LT	25	#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>
52e8a6a2	33	#include <linux/hdlc.h>
1da177e4	34	#include <linux/ioport.h>
5a0e3ad6	35	#include <linux/slab.h>
1da177e4 LT	36	#include <net/arp.h>
1da177e4 LT	37
82729971	38	#include <asm/irq.h>
1da177e4 LT	39	#include <asm/io.h>
	40	#include <asm/dma.h>
	41	#include <asm/byteorder.h>
1da177e4 LT	42	#include "z85230.h"
	43
	44	static int dma;
	45
1da177e4 LT	46	/*
	47	* Network driver support routines
	48	*/
	49
52e8a6a2 KH	50	static inline struct z8530_dev* dev_to_sv(struct net_device *dev)
	51	{
	52	return (struct z8530_dev *)dev_to_hdlc(dev)->priv;
	53	}
	54
1da177e4	55	/*
52e8a6a2	56	* Frame receive. Simple for our card as we do HDLC and there
1da177e4 LT	57	* is no funny garbage involved
1da177e4 LT	58	*/
52e8a6a2	59
1da177e4 LT	60	static 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 ;) */
52e8a6a2 KH	63	skb_trim(skb, skb->len - 2);
52e8a6a2 KH	64	skb->protocol = hdlc_type_trans(skb, c->netdevice);
98e399f8	65	skb_reset_mac_header(skb);
52e8a6a2	66	skb->dev = c->netdevice;
1da177e4 LT	67	/*
	68	* Send it to the PPP layer. We don't have time to process
	69	* it right now.
	70	*/
	71	netif_rx(skb);
1da177e4	72	}
52e8a6a2	73
1da177e4 LT	74	/*
1da177e4 LT	75	* We've been placed in the UP state
52e8a6a2 KH	76	*/
52e8a6a2 KH	77
1da177e4 LT	78	static int hostess_open(struct net_device *d)
1da177e4 LT	79	{
52e8a6a2	80	struct z8530_dev *sv11 = dev_to_sv(d);
1da177e4	81	int err = -1;
52e8a6a2	82
1da177e4 LT	83	/*
	84	* Link layer up
	85	*/
52e8a6a2	86	switch (dma) {
1da177e4	87	case 0:
52e8a6a2	88	err = z8530_sync_open(d, &sv11->chanA);
1da177e4 LT	89	break;
1da177e4 LT	90	case 1:
52e8a6a2	91	err = z8530_sync_dma_open(d, &sv11->chanA);
1da177e4 LT	92	break;
1da177e4 LT	93	case 2:
52e8a6a2	94	err = z8530_sync_txdma_open(d, &sv11->chanA);
1da177e4 LT	95	break;
1da177e4 LT	96	}
52e8a6a2 KH	97
52e8a6a2 KH	98	if (err)
1da177e4	99	return err;
52e8a6a2 KH	100
	101	err = hdlc_open(d);
	102	if (err) {
	103	switch (dma) {
1da177e4	104	case 0:
52e8a6a2	105	z8530_sync_close(d, &sv11->chanA);
1da177e4 LT	106	break;
1da177e4 LT	107	case 1:
52e8a6a2	108	z8530_sync_dma_close(d, &sv11->chanA);
1da177e4 LT	109	break;
1da177e4 LT	110	case 2:
52e8a6a2	111	z8530_sync_txdma_close(d, &sv11->chanA);
1da177e4	112	break;
52e8a6a2	113	}
1da177e4 LT	114	return err;
1da177e4 LT	115	}
52e8a6a2 KH	116	sv11->chanA.rx_function = hostess_input;
52e8a6a2 KH	117
1da177e4 LT	118	/*
	119	* Go go go
	120	*/
	121
	122	netif_start_queue(d);
	123	return 0;
	124	}
	125
	126	static int hostess_close(struct net_device *d)
	127	{
52e8a6a2	128	struct z8530_dev *sv11 = dev_to_sv(d);
1da177e4 LT	129	/*
	130	* Discard new frames
	131	*/
52e8a6a2 KH	132	sv11->chanA.rx_function = z8530_null_rx;
	133
	134	hdlc_close(d);
1da177e4	135	netif_stop_queue(d);
52e8a6a2 KH	136
52e8a6a2 KH	137	switch (dma) {
1da177e4	138	case 0:
52e8a6a2	139	z8530_sync_close(d, &sv11->chanA);
1da177e4 LT	140	break;
1da177e4 LT	141	case 1:
52e8a6a2	142	z8530_sync_dma_close(d, &sv11->chanA);
1da177e4 LT	143	break;
1da177e4 LT	144	case 2:
52e8a6a2	145	z8530_sync_txdma_close(d, &sv11->chanA);
1da177e4 LT	146	break;
	147	}
	148	return 0;
	149	}
	150
	151	static int hostess_ioctl(struct net_device d, struct ifreq ifr, int cmd)
	152	{
52e8a6a2 KH	153	/* struct z8530_dev *sv11=dev_to_sv(d);
	154	z8530_ioctl(d,&sv11->chanA,ifr,cmd) */
	155	return hdlc_ioctl(d, ifr, cmd);
1da177e4 LT	156	}
	157
	158	/*
52e8a6a2	159	* Passed network frames, fire them downwind.
1da177e4	160	*/
52e8a6a2	161
d71a6749 SH	162	static netdev_tx_t hostess_queue_xmit(struct sk_buff *skb,
d71a6749 SH	163	struct net_device *d)
1da177e4	164	{
52e8a6a2	165	return z8530_queue_xmit(&dev_to_sv(d)->chanA, skb);
1da177e4 LT	166	}
1da177e4 LT	167
52e8a6a2 KH	168	static int hostess_attach(struct net_device *dev, unsigned short encoding,
52e8a6a2 KH	169	unsigned short parity)
1da177e4	170	{
52e8a6a2 KH	171	if (encoding == ENCODING_NRZ && parity == PARITY_CRC16_PR1_CCITT)
	172	return 0;
	173	return -EINVAL;
1da177e4 LT	174	}
	175
	176	/*
	177	* Description block for a Comtrol Hostess SV11 card
	178	*/
52e8a6a2	179
991990a1 KH	180	static 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
52e8a6a2	188	static struct z8530_dev *sv11_init(int iobase, int irq)
1da177e4	189	{
52e8a6a2 KH	190	struct z8530_dev *sv;
52e8a6a2 KH	191	struct net_device *netdev;
1da177e4 LT	192	/*
	193	* Get the needed I/O space
	194	*/
52e8a6a2 KH	195
52e8a6a2 KH	196	if (!request_region(iobase, 8, "Comtrol SV11")) {
23efcb73	197	pr_warn("I/O 0x%X already in use\n", iobase);
1da177e4 LT	198	return NULL;
1da177e4 LT	199	}
52e8a6a2 KH	200
	201	sv = kzalloc(sizeof(struct z8530_dev), GFP_KERNEL);
	202	if (!sv)
	203	goto err_kzalloc;
	204
1da177e4 LT	205	/*
	206	* Stuff in the I/O addressing
	207	*/
52e8a6a2 KH	208
	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
1da177e4 LT	220	/* We want a fast IRQ for this device. Actually we'd like an even faster
1da177e4 LT	221	IRQ ;) - This is one driver RtLinux is made for */
52e8a6a2	222
0ca45208	223	if (request_irq(irq, z8530_interrupt, 0,
52e8a6a2	224	"Hostess SV11", sv) < 0) {
23efcb73	225	pr_warn("IRQ %d already in use\n", irq);
52e8a6a2	226	goto err_irq;
1da177e4	227	}
52e8a6a2 KH	228
	229	sv->irq = irq;
	230	sv->chanA.private = sv;
	231	sv->chanA.dev = sv;
	232	sv->chanB.dev = sv;
	233
	234	if (dma) {
1da177e4 LT	235	/*
	236	* You can have DMA off or 1 and 3 thats the lot
	237	* on the Comtrol.
	238	*/
52e8a6a2 KH	239	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;
1da177e4 LT	248	}
	249
	250	/* Kill our private IRQ line the hostess can end up chattering
	251	until the configuration is set */
	252	disable_irq(irq);
52e8a6a2	253
1da177e4 LT	254	/*
	255	* Begin normal initialise
	256	*/
52e8a6a2 KH	257
52e8a6a2 KH	258	if (z8530_init(sv)) {
23efcb73	259	pr_err("Z8530 series device not found\n");
1da177e4	260	enable_irq(irq);
52e8a6a2	261	goto free_dma;
1da177e4	262	}
52e8a6a2 KH	263	z8530_channel_load(&sv->chanB, z8530_dead_port);
	264	if (sv->type == Z85C30)
	265	z8530_channel_load(&sv->chanA, z8530_hdlc_kilostream);
1da177e4	266	else
52e8a6a2 KH	267	z8530_channel_load(&sv->chanA, z8530_hdlc_kilostream_85230);
52e8a6a2 KH	268
1da177e4	269	enable_irq(irq);
1da177e4 LT	270
	271	/*
	272	* Now we can take the IRQ
	273	*/
1da177e4	274
52e8a6a2 KH	275	sv->chanA.netdevice = netdev = alloc_hdlcdev(sv);
	276	if (!netdev)
	277	goto free_dma;
1da177e4	278
52e8a6a2 KH	279	dev_to_hdlc(netdev)->attach = hostess_attach;
52e8a6a2 KH	280	dev_to_hdlc(netdev)->xmit = hostess_queue_xmit;
991990a1	281	netdev->netdev_ops = &hostess_ops;
52e8a6a2 KH	282	netdev->base_addr = iobase;
	283	netdev->irq = irq;
	284
	285	if (register_hdlc_device(netdev)) {
23efcb73	286	pr_err("unable to register HDLC device\n");
52e8a6a2 KH	287	free_netdev(netdev);
52e8a6a2 KH	288	goto free_dma;
1da177e4	289	}
52e8a6a2 KH	290
	291	z8530_describe(sv, "I/O", iobase);
	292	sv->active = 1;
	293	return sv;
	294
	295	free_dma:
	296	if (dma == 1)
	297	free_dma(sv->chanA.rxdma);
	298	err_rxdma:
	299	if (dma)
	300	free_dma(sv->chanA.txdma);
	301	err_txdma:
	302	free_irq(irq, sv);
	303	err_irq:
1da177e4	304	kfree(sv);
52e8a6a2 KH	305	err_kzalloc:
52e8a6a2 KH	306	release_region(iobase, 8);
1da177e4 LT	307	return NULL;
	308	}
	309
52e8a6a2	310	static void sv11_shutdown(struct z8530_dev *dev)
1da177e4	311	{
52e8a6a2 KH	312	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);
1da177e4	319	}
52e8a6a2 KH	320	release_region(dev->chanA.ctrlio - 1, 8);
52e8a6a2 KH	321	free_netdev(dev->chanA.netdevice);
1da177e4 LT	322	kfree(dev);
	323	}
	324
52e8a6a2 KH	325	static int io = 0x200;
52e8a6a2 KH	326	static int irq = 9;
1da177e4 LT	327
	328	module_param(io, int, 0);
	329	MODULE_PARM_DESC(io, "The I/O base of the Comtrol Hostess SV11 card");
	330	module_param(dma, int, 0);
	331	MODULE_PARM_DESC(dma, "Set this to 1 to use DMA1/DMA3 for TX/RX");
	332	module_param(irq, int, 0);
	333	MODULE_PARM_DESC(irq, "The interrupt line setting for the Comtrol Hostess SV11 card");
	334
	335	MODULE_AUTHOR("Alan Cox");
	336	MODULE_LICENSE("GPL");
	337	MODULE_DESCRIPTION("Modular driver for the Comtrol Hostess SV11");
	338
52e8a6a2	339	static struct z8530_dev *sv11_unit;
1da177e4 LT	340
	341	int init_module(void)
	342	{
52e8a6a2	343	if ((sv11_unit = sv11_init(io, irq)) == NULL)
1da177e4 LT	344	return -ENODEV;
	345	return 0;
	346	}
	347
	348	void cleanup_module(void)
	349	{
52e8a6a2	350	if (sv11_unit)
1da177e4 LT	351	sv11_shutdown(sv11_unit);
1da177e4 LT	352	}