[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 isnt wired (why - beats me)
 *
 *	Generic HDLC port Copyright (C) 2008 Krzysztof Halasa <khc@pm.waw.pl>
 */

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