[mirror_ubuntu-artful-kernel.git] / drivers / net / wan / pc300too.c

/*
 * Cyclades PC300 synchronous serial card driver for Linux
 *
 * Copyright (C) 2000-2008 Krzysztof Halasa <khc@pm.waw.pl>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License
 * as published by the Free Software Foundation.
 *
 * For information see <http://www.kernel.org/pub/linux/utils/net/hdlc/>.
 *
 * Sources of information:
 *    Hitachi HD64572 SCA-II User's Manual
 *    Original Cyclades PC300 Linux driver
 *
 * This driver currently supports only PC300/RSV (V.24/V.35) and
 * PC300/X21 cards.
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/slab.h>
#include <linux/sched.h>
#include <linux/types.h>
#include <linux/fcntl.h>
#include <linux/in.h>
#include <linux/string.h>
#include <linux/errno.h>
#include <linux/init.h>
#include <linux/ioport.h>
#include <linux/moduleparam.h>
#include <linux/netdevice.h>
#include <linux/hdlc.h>
#include <linux/pci.h>
#include <linux/delay.h>
#include <asm/io.h>

#include "hd64572.h"

#undef DEBUG_PKT
#define DEBUG_RINGS

#define PC300_PLX_SIZE		0x80    /* PLX control window size (128 B) */
#define PC300_SCA_SIZE		0x400   /* SCA window size (1 KB) */
#define MAX_TX_BUFFERS		10

static int pci_clock_freq = 33000000;
static int use_crystal_clock = 0;
static unsigned int CLOCK_BASE;

/* Masks to access the init_ctrl PLX register */
#define PC300_CLKSEL_MASK	 (0x00000004UL)
#define PC300_CHMEDIA_MASK(port) (0x00000020UL << ((port) * 3))
#define PC300_CTYPE_MASK	 (0x00000800UL)


enum { PC300_RSV = 1, PC300_X21, PC300_TE }; /* card types */

/*
 *      PLX PCI9050-1 local configuration and shared runtime registers.
 *      This structure can be used to access 9050 registers (memory mapped).
 */
typedef struct {
	u32 loc_addr_range[4];	/* 00-0Ch : Local Address Ranges */
	u32 loc_rom_range;	/* 10h : Local ROM Range */
	u32 loc_addr_base[4];	/* 14-20h : Local Address Base Addrs */
	u32 loc_rom_base;	/* 24h : Local ROM Base */
	u32 loc_bus_descr[4];	/* 28-34h : Local Bus Descriptors */
	u32 rom_bus_descr;	/* 38h : ROM Bus Descriptor */
	u32 cs_base[4];		/* 3C-48h : Chip Select Base Addrs */
	u32 intr_ctrl_stat;	/* 4Ch : Interrupt Control/Status */
	u32 init_ctrl;		/* 50h : EEPROM ctrl, Init Ctrl, etc */
}plx9050;


typedef struct port_s {
	struct napi_struct napi;
	struct net_device *netdev;
	struct card_s *card;
	spinlock_t lock;	/* TX lock */
	sync_serial_settings settings;
	int rxpart;		/* partial frame received, next frame invalid*/
	unsigned short encoding;
	unsigned short parity;
	unsigned int iface;
	u16 rxin;		/* rx ring buffer 'in' pointer */
	u16 txin;		/* tx ring buffer 'in' and 'last' pointers */
	u16 txlast;
	u8 rxs, txs, tmc;	/* SCA registers */
	u8 chan;		/* physical port # - 0 or 1 */
}port_t;


typedef struct card_s {
	int type;		/* RSV, X21, etc. */
	int n_ports;		/* 1 or 2 ports */
	u8 __iomem *rambase;	/* buffer memory base (virtual) */
	u8 __iomem *scabase;	/* SCA memory base (virtual) */
	plx9050 __iomem *plxbase; /* PLX registers memory base (virtual) */
	u32 init_ctrl_value;	/* Saved value - 9050 bug workaround */
	u16 rx_ring_buffers;	/* number of buffers in a ring */
	u16 tx_ring_buffers;
	u16 buff_offset;	/* offset of first buffer of first channel */
	u8 irq;			/* interrupt request level */

	port_t ports[2];
}card_t;


#define get_port(card, port)	     ((port) < (card)->n_ports ? \
					 (&(card)->ports[port]) : (NULL))

#include "hd64572.c"


static void pc300_set_iface(port_t *port)
{
	card_t *card = port->card;
	u32 __iomem * init_ctrl = &card->plxbase->init_ctrl;
	u16 msci = get_msci(port);
	u8 rxs = port->rxs & CLK_BRG_MASK;
	u8 txs = port->txs & CLK_BRG_MASK;

	sca_out(EXS_TES1, (port->chan ? MSCI1_OFFSET : MSCI0_OFFSET) + EXS,
		port->card);
	switch(port->settings.clock_type) {
	case CLOCK_INT:
		rxs |= CLK_BRG; /* BRG output */
		txs |= CLK_PIN_OUT | CLK_TX_RXCLK; /* RX clock */
		break;

	case CLOCK_TXINT:
		rxs |= CLK_LINE; /* RXC input */
		txs |= CLK_PIN_OUT | CLK_BRG; /* BRG output */
		break;

	case CLOCK_TXFROMRX:
		rxs |= CLK_LINE; /* RXC input */
		txs |= CLK_PIN_OUT | CLK_TX_RXCLK; /* RX clock */
		break;

	default:		/* EXTernal clock */
		rxs |= CLK_LINE; /* RXC input */
		txs |= CLK_PIN_OUT | CLK_LINE; /* TXC input */
		break;
	}

	port->rxs = rxs;
	port->txs = txs;
	sca_out(rxs, msci + RXS, card);
	sca_out(txs, msci + TXS, card);
	sca_set_port(port);

	if (port->card->type == PC300_RSV) {
		if (port->iface == IF_IFACE_V35)
			writel(card->init_ctrl_value |
			       PC300_CHMEDIA_MASK(port->chan), init_ctrl);
		else
			writel(card->init_ctrl_value &
			       ~PC300_CHMEDIA_MASK(port->chan), init_ctrl);
	}
}


static int pc300_open(struct net_device *dev)
{
	port_t *port = dev_to_port(dev);

	int result = hdlc_open(dev);
	if (result)
		return result;

	sca_open(dev);
	pc300_set_iface(port);
	return 0;
}


static int pc300_close(struct net_device *dev)
{
	sca_close(dev);
	hdlc_close(dev);
	return 0;
}


static int pc300_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
{
	const size_t size = sizeof(sync_serial_settings);
	sync_serial_settings new_line;
	sync_serial_settings __user *line = ifr->ifr_settings.ifs_ifsu.sync;
	int new_type;
	port_t *port = dev_to_port(dev);

#ifdef DEBUG_RINGS
	if (cmd == SIOCDEVPRIVATE) {
		sca_dump_rings(dev);
		return 0;
	}
#endif
	if (cmd != SIOCWANDEV)
		return hdlc_ioctl(dev, ifr, cmd);

	if (ifr->ifr_settings.type == IF_GET_IFACE) {
		ifr->ifr_settings.type = port->iface;
		if (ifr->ifr_settings.size < size) {
			ifr->ifr_settings.size = size; /* data size wanted */
			return -ENOBUFS;
		}
		if (copy_to_user(line, &port->settings, size))
			return -EFAULT;
		return 0;

	}

	if (port->card->type == PC300_X21 &&
	    (ifr->ifr_settings.type == IF_IFACE_SYNC_SERIAL ||
	     ifr->ifr_settings.type == IF_IFACE_X21))
		new_type = IF_IFACE_X21;

	else if (port->card->type == PC300_RSV &&
		 (ifr->ifr_settings.type == IF_IFACE_SYNC_SERIAL ||
		  ifr->ifr_settings.type == IF_IFACE_V35))
		new_type = IF_IFACE_V35;

	else if (port->card->type == PC300_RSV &&
		 ifr->ifr_settings.type == IF_IFACE_V24)
		new_type = IF_IFACE_V24;

	else
		return hdlc_ioctl(dev, ifr, cmd);

	if (!capable(CAP_NET_ADMIN))
		return -EPERM;

	if (copy_from_user(&new_line, line, size))
		return -EFAULT;

	if (new_line.clock_type != CLOCK_EXT &&
	    new_line.clock_type != CLOCK_TXFROMRX &&
	    new_line.clock_type != CLOCK_INT &&
	    new_line.clock_type != CLOCK_TXINT)
		return -EINVAL;	/* No such clock setting */

	if (new_line.loopback != 0 && new_line.loopback != 1)
		return -EINVAL;

	memcpy(&port->settings, &new_line, size); /* Update settings */
	port->iface = new_type;
	pc300_set_iface(port);
	return 0;
}


static void pc300_pci_remove_one(struct pci_dev *pdev)
{
	int i;
	card_t *card = pci_get_drvdata(pdev);

	for (i = 0; i < 2; i++)
		if (card->ports[i].card)
			unregister_hdlc_device(card->ports[i].netdev);

	if (card->irq)
		free_irq(card->irq, card);

	if (card->rambase)
		iounmap(card->rambase);
	if (card->scabase)
		iounmap(card->scabase);
	if (card->plxbase)
		iounmap(card->plxbase);

	pci_release_regions(pdev);
	pci_disable_device(pdev);
	if (card->ports[0].netdev)
		free_netdev(card->ports[0].netdev);
	if (card->ports[1].netdev)
		free_netdev(card->ports[1].netdev);
	kfree(card);
}

static const struct net_device_ops pc300_ops = {
	.ndo_open       = pc300_open,
	.ndo_stop       = pc300_close,
	.ndo_start_xmit = hdlc_start_xmit,
	.ndo_do_ioctl   = pc300_ioctl,
};

static int pc300_pci_init_one(struct pci_dev *pdev,
			      const struct pci_device_id *ent)
{
	card_t *card;
	u32 __iomem *p;
	int i;
	u32 ramsize;
	u32 ramphys;		/* buffer memory base */
	u32 scaphys;		/* SCA memory base */
	u32 plxphys;		/* PLX registers memory base */

	i = pci_enable_device(pdev);
	if (i)
		return i;

	i = pci_request_regions(pdev, "PC300");
	if (i) {
		pci_disable_device(pdev);
		return i;
	}

	card = kzalloc(sizeof(card_t), GFP_KERNEL);
	if (card == NULL) {
		pci_release_regions(pdev);
		pci_disable_device(pdev);
		return -ENOBUFS;
	}
	pci_set_drvdata(pdev, card);

	if (pci_resource_len(pdev, 0) != PC300_PLX_SIZE ||
	    pci_resource_len(pdev, 2) != PC300_SCA_SIZE ||
	    pci_resource_len(pdev, 3) < 16384) {
		pr_err("invalid card EEPROM parameters\n");
		pc300_pci_remove_one(pdev);
		return -EFAULT;
	}

	plxphys = pci_resource_start(pdev, 0) & PCI_BASE_ADDRESS_MEM_MASK;
	card->plxbase = ioremap(plxphys, PC300_PLX_SIZE);

	scaphys = pci_resource_start(pdev, 2) & PCI_BASE_ADDRESS_MEM_MASK;
	card->scabase = ioremap(scaphys, PC300_SCA_SIZE);

	ramphys = pci_resource_start(pdev, 3) & PCI_BASE_ADDRESS_MEM_MASK;
	card->rambase = pci_ioremap_bar(pdev, 3);

	if (card->plxbase == NULL ||
	    card->scabase == NULL ||
	    card->rambase == NULL) {
		pr_err("ioremap() failed\n");
		pc300_pci_remove_one(pdev);
		return -ENOMEM;
	}

	/* PLX PCI 9050 workaround for local configuration register read bug */
	pci_write_config_dword(pdev, PCI_BASE_ADDRESS_0, scaphys);
	card->init_ctrl_value = readl(&((plx9050 __iomem *)card->scabase)->init_ctrl);
	pci_write_config_dword(pdev, PCI_BASE_ADDRESS_0, plxphys);

	if (pdev->device == PCI_DEVICE_ID_PC300_TE_1 ||
	    pdev->device == PCI_DEVICE_ID_PC300_TE_2)
		card->type = PC300_TE; /* not fully supported */
	else if (card->init_ctrl_value & PC300_CTYPE_MASK)
		card->type = PC300_X21;
	else
		card->type = PC300_RSV;

	if (pdev->device == PCI_DEVICE_ID_PC300_RX_1 ||
	    pdev->device == PCI_DEVICE_ID_PC300_TE_1)
		card->n_ports = 1;
	else
		card->n_ports = 2;

	for (i = 0; i < card->n_ports; i++)
		if (!(card->ports[i].netdev = alloc_hdlcdev(&card->ports[i]))) {
			pr_err("unable to allocate memory\n");
			pc300_pci_remove_one(pdev);
			return -ENOMEM;
		}

	/* Reset PLX */
	p = &card->plxbase->init_ctrl;
	writel(card->init_ctrl_value | 0x40000000, p);
	readl(p);		/* Flush the write - do not use sca_flush */
	udelay(1);

	writel(card->init_ctrl_value, p);
	readl(p);		/* Flush the write - do not use sca_flush */
	udelay(1);

	/* Reload Config. Registers from EEPROM */
	writel(card->init_ctrl_value | 0x20000000, p);
	readl(p);		/* Flush the write - do not use sca_flush */
	udelay(1);

	writel(card->init_ctrl_value, p);
	readl(p);		/* Flush the write - do not use sca_flush */
	udelay(1);

	ramsize = sca_detect_ram(card, card->rambase,
				 pci_resource_len(pdev, 3));

	if (use_crystal_clock)
		card->init_ctrl_value &= ~PC300_CLKSEL_MASK;
	else
		card->init_ctrl_value |= PC300_CLKSEL_MASK;

	writel(card->init_ctrl_value, &card->plxbase->init_ctrl);
	/* number of TX + RX buffers for one port */
	i = ramsize / (card->n_ports * (sizeof(pkt_desc) + HDLC_MAX_MRU));
	card->tx_ring_buffers = min(i / 2, MAX_TX_BUFFERS);
	card->rx_ring_buffers = i - card->tx_ring_buffers;

	card->buff_offset = card->n_ports * sizeof(pkt_desc) *
		(card->tx_ring_buffers + card->rx_ring_buffers);

	pr_info("PC300/%s, %u KB RAM at 0x%x, IRQ%u, using %u TX + %u RX packets rings\n",
		card->type == PC300_X21 ? "X21" :
		card->type == PC300_TE ? "TE" : "RSV",
		ramsize / 1024, ramphys, pdev->irq,
		card->tx_ring_buffers, card->rx_ring_buffers);

	if (card->tx_ring_buffers < 1) {
		pr_err("RAM test failed\n");
		pc300_pci_remove_one(pdev);
		return -EFAULT;
	}

	/* Enable interrupts on the PCI bridge, LINTi1 active low */
	writew(0x0041, &card->plxbase->intr_ctrl_stat);

	/* Allocate IRQ */
	if (request_irq(pdev->irq, sca_intr, IRQF_SHARED, "pc300", card)) {
		pr_warn("could not allocate IRQ%d\n", pdev->irq);
		pc300_pci_remove_one(pdev);
		return -EBUSY;
	}
	card->irq = pdev->irq;

	sca_init(card, 0);

	// COTE not set - allows better TX DMA settings
	// sca_out(sca_in(PCR, card) | PCR_COTE, PCR, card);

	sca_out(0x10, BTCR, card);

	for (i = 0; i < card->n_ports; i++) {
		port_t *port = &card->ports[i];
		struct net_device *dev = port->netdev;
		hdlc_device *hdlc = dev_to_hdlc(dev);
		port->chan = i;

		spin_lock_init(&port->lock);
		dev->irq = card->irq;
		dev->mem_start = ramphys;
		dev->mem_end = ramphys + ramsize - 1;
		dev->tx_queue_len = 50;
		dev->netdev_ops = &pc300_ops;
		hdlc->attach = sca_attach;
		hdlc->xmit = sca_xmit;
		port->settings.clock_type = CLOCK_EXT;
		port->card = card;
		if (card->type == PC300_X21)
			port->iface = IF_IFACE_X21;
		else
			port->iface = IF_IFACE_V35;

		sca_init_port(port);
		if (register_hdlc_device(dev)) {
			pr_err("unable to register hdlc device\n");
			port->card = NULL;
			pc300_pci_remove_one(pdev);
			return -ENOBUFS;
		}

		netdev_info(dev, "PC300 channel %d\n", port->chan);
	}
	return 0;
}


static const struct pci_device_id pc300_pci_tbl[] = {
	{ PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_PC300_RX_1, PCI_ANY_ID,
	  PCI_ANY_ID, 0, 0, 0 },
	{ PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_PC300_RX_2, PCI_ANY_ID,
	  PCI_ANY_ID, 0, 0, 0 },
	{ PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_PC300_TE_1, PCI_ANY_ID,
	  PCI_ANY_ID, 0, 0, 0 },
	{ PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_PC300_TE_2, PCI_ANY_ID,
	  PCI_ANY_ID, 0, 0, 0 },
	{ 0, }
};


static struct pci_driver pc300_pci_driver = {
	.name =          "PC300",
	.id_table =      pc300_pci_tbl,
	.probe =         pc300_pci_init_one,
	.remove =        pc300_pci_remove_one,
};


static int __init pc300_init_module(void)
{
	if (pci_clock_freq < 1000000 || pci_clock_freq > 80000000) {
		pr_err("Invalid PCI clock frequency\n");
		return -EINVAL;
	}
	if (use_crystal_clock != 0 && use_crystal_clock != 1) {
		pr_err("Invalid 'use_crystal_clock' value\n");
		return -EINVAL;
	}

	CLOCK_BASE = use_crystal_clock ? 24576000 : pci_clock_freq;

	return pci_register_driver(&pc300_pci_driver);
}


static void __exit pc300_cleanup_module(void)
{
	pci_unregister_driver(&pc300_pci_driver);
}

MODULE_AUTHOR("Krzysztof Halasa <khc@pm.waw.pl>");
MODULE_DESCRIPTION("Cyclades PC300 serial port driver");
MODULE_LICENSE("GPL v2");
MODULE_DEVICE_TABLE(pci, pc300_pci_tbl);
module_param(pci_clock_freq, int, 0444);
MODULE_PARM_DESC(pci_clock_freq, "System PCI clock frequency in Hz");
module_param(use_crystal_clock, int, 0444);
MODULE_PARM_DESC(use_crystal_clock,
		 "Use 24.576 MHz clock instead of PCI clock");
module_init(pc300_init_module);
module_exit(pc300_cleanup_module);
Commit	Line	Data
7517c1b7 KH	1	/*
	2	* Cyclades PC300 synchronous serial card driver for Linux
	3	*
61e0a6a2	4	* Copyright (C) 2000-2008 Krzysztof Halasa <khc@pm.waw.pl>
7517c1b7 KH	5	*
	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms of version 2 of the GNU General Public License
	8	* as published by the Free Software Foundation.
	9	*
	10	* For information see <http://www.kernel.org/pub/linux/utils/net/hdlc/>.
	11	*
	12	* Sources of information:
	13	* Hitachi HD64572 SCA-II User's Manual
61e0a6a2	14	* Original Cyclades PC300 Linux driver
7517c1b7 KH	15	*
	16	* This driver currently supports only PC300/RSV (V.24/V.35) and
	17	* PC300/X21 cards.
	18	*/
	19
12a3bfef JP	20	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
12a3bfef JP	21
7517c1b7 KH	22	#include <linux/module.h>
	23	#include <linux/kernel.h>
	24	#include <linux/slab.h>
	25	#include <linux/sched.h>
	26	#include <linux/types.h>
	27	#include <linux/fcntl.h>
	28	#include <linux/in.h>
	29	#include <linux/string.h>
	30	#include <linux/errno.h>
	31	#include <linux/init.h>
	32	#include <linux/ioport.h>
	33	#include <linux/moduleparam.h>
	34	#include <linux/netdevice.h>
	35	#include <linux/hdlc.h>
	36	#include <linux/pci.h>
	37	#include <linux/delay.h>
	38	#include <asm/io.h>
	39
	40	#include "hd64572.h"
	41
7517c1b7 KH	42	#undef DEBUG_PKT
	43	#define DEBUG_RINGS
	44
	45	#define PC300_PLX_SIZE 0x80 /* PLX control window size (128 B) */
	46	#define PC300_SCA_SIZE 0x400 /* SCA window size (1 KB) */
7517c1b7 KH	47	#define MAX_TX_BUFFERS 10
	48
	49	static int pci_clock_freq = 33000000;
	50	static int use_crystal_clock = 0;
	51	static unsigned int CLOCK_BASE;
	52
	53	/* Masks to access the init_ctrl PLX register */
	54	#define PC300_CLKSEL_MASK (0x00000004UL)
	55	#define PC300_CHMEDIA_MASK(port) (0x00000020UL << ((port) * 3))
	56	#define PC300_CTYPE_MASK (0x00000800UL)
	57
	58
	59	enum { PC300_RSV = 1, PC300_X21, PC300_TE }; /* card types */
	60
	61	/*
	62	* PLX PCI9050-1 local configuration and shared runtime registers.
	63	* This structure can be used to access 9050 registers (memory mapped).
	64	*/
	65	typedef struct {
	66	u32 loc_addr_range[4]; /* 00-0Ch : Local Address Ranges */
	67	u32 loc_rom_range; /* 10h : Local ROM Range */
	68	u32 loc_addr_base[4]; /* 14-20h : Local Address Base Addrs */
	69	u32 loc_rom_base; /* 24h : Local ROM Base */
	70	u32 loc_bus_descr[4]; /* 28-34h : Local Bus Descriptors */
	71	u32 rom_bus_descr; /* 38h : ROM Bus Descriptor */
	72	u32 cs_base[4]; /* 3C-48h : Chip Select Base Addrs */
	73	u32 intr_ctrl_stat; /* 4Ch : Interrupt Control/Status */
	74	u32 init_ctrl; /* 50h : EEPROM ctrl, Init Ctrl, etc */
	75	}plx9050;
	76
	77
	78
	79	typedef struct port_s {
abc9d91a	80	struct napi_struct napi;
61e0a6a2	81	struct net_device *netdev;
7517c1b7 KH	82	struct card_s *card;
	83	spinlock_t lock; /* TX lock */
	84	sync_serial_settings settings;
	85	int rxpart; /* partial frame received, next frame invalid*/
	86	unsigned short encoding;
	87	unsigned short parity;
	88	unsigned int iface;
	89	u16 rxin; /* rx ring buffer 'in' pointer */
	90	u16 txin; /* tx ring buffer 'in' and 'last' pointers */
	91	u16 txlast;
	92	u8 rxs, txs, tmc; /* SCA registers */
61e0a6a2	93	u8 chan; /* physical port # - 0 or 1 */
7517c1b7 KH	94	}port_t;
	95
	96
	97
	98	typedef struct card_s {
	99	int type; /* RSV, X21, etc. */
	100	int n_ports; /* 1 or 2 ports */
184123db AV	101	u8 __iomem rambase; / buffer memory base (virtual) */
184123db AV	102	u8 __iomem scabase; / SCA memory base (virtual) */
7517c1b7 KH	103	plx9050 __iomem plxbase; / PLX registers memory base (virtual) */
	104	u32 init_ctrl_value; /* Saved value - 9050 bug workaround */
	105	u16 rx_ring_buffers; /* number of buffers in a ring */
	106	u16 tx_ring_buffers;
	107	u16 buff_offset; /* offset of first buffer of first channel */
	108	u8 irq; /* interrupt request level */
	109
	110	port_t ports[2];
	111	}card_t;
	112
	113
7517c1b7 KH	114	#define get_port(card, port) ((port) < (card)->n_ports ? \
	115	(&(card)->ports[port]) : (NULL))
	116
6b40aba3	117	#include "hd64572.c"
7517c1b7 KH	118
	119
	120	static void pc300_set_iface(port_t *port)
	121	{
	122	card_t *card = port->card;
184123db	123	u32 __iomem * init_ctrl = &card->plxbase->init_ctrl;
7517c1b7 KH	124	u16 msci = get_msci(port);
	125	u8 rxs = port->rxs & CLK_BRG_MASK;
	126	u8 txs = port->txs & CLK_BRG_MASK;
	127
61e0a6a2 KH	128	sca_out(EXS_TES1, (port->chan ? MSCI1_OFFSET : MSCI0_OFFSET) + EXS,
61e0a6a2 KH	129	port->card);
7517c1b7 KH	130	switch(port->settings.clock_type) {
	131	case CLOCK_INT:
	132	rxs \|= CLK_BRG; /* BRG output */
	133	txs \|= CLK_PIN_OUT \| CLK_TX_RXCLK; /* RX clock */
	134	break;
	135
	136	case CLOCK_TXINT:
	137	rxs \|= CLK_LINE; /* RXC input */
	138	txs \|= CLK_PIN_OUT \| CLK_BRG; /* BRG output */
	139	break;
	140
	141	case CLOCK_TXFROMRX:
	142	rxs \|= CLK_LINE; /* RXC input */
	143	txs \|= CLK_PIN_OUT \| CLK_TX_RXCLK; /* RX clock */
	144	break;
	145
	146	default: /* EXTernal clock */
	147	rxs \|= CLK_LINE; /* RXC input */
	148	txs \|= CLK_PIN_OUT \| CLK_LINE; /* TXC input */
	149	break;
	150	}
	151
	152	port->rxs = rxs;
	153	port->txs = txs;
	154	sca_out(rxs, msci + RXS, card);
	155	sca_out(txs, msci + TXS, card);
	156	sca_set_port(port);
	157
	158	if (port->card->type == PC300_RSV) {
	159	if (port->iface == IF_IFACE_V35)
	160	writel(card->init_ctrl_value \|
61e0a6a2	161	PC300_CHMEDIA_MASK(port->chan), init_ctrl);
7517c1b7 KH	162	else
7517c1b7 KH	163	writel(card->init_ctrl_value &
61e0a6a2	164	~PC300_CHMEDIA_MASK(port->chan), init_ctrl);
7517c1b7 KH	165	}
	166	}
	167
	168
	169
	170	static int pc300_open(struct net_device *dev)
	171	{
	172	port_t *port = dev_to_port(dev);
	173
	174	int result = hdlc_open(dev);
	175	if (result)
	176	return result;
	177
	178	sca_open(dev);
	179	pc300_set_iface(port);
	180	return 0;
	181	}
	182
	183
	184
	185	static int pc300_close(struct net_device *dev)
	186	{
	187	sca_close(dev);
	188	hdlc_close(dev);
	189	return 0;
	190	}
	191
	192
	193
	194	static int pc300_ioctl(struct net_device dev, struct ifreq ifr, int cmd)
	195	{
	196	const size_t size = sizeof(sync_serial_settings);
	197	sync_serial_settings new_line;
	198	sync_serial_settings __user *line = ifr->ifr_settings.ifs_ifsu.sync;
	199	int new_type;
	200	port_t *port = dev_to_port(dev);
	201
	202	#ifdef DEBUG_RINGS
	203	if (cmd == SIOCDEVPRIVATE) {
	204	sca_dump_rings(dev);
	205	return 0;
	206	}
	207	#endif
	208	if (cmd != SIOCWANDEV)
	209	return hdlc_ioctl(dev, ifr, cmd);
	210
	211	if (ifr->ifr_settings.type == IF_GET_IFACE) {
	212	ifr->ifr_settings.type = port->iface;
	213	if (ifr->ifr_settings.size < size) {
	214	ifr->ifr_settings.size = size; /* data size wanted */
	215	return -ENOBUFS;
	216	}
	217	if (copy_to_user(line, &port->settings, size))
	218	return -EFAULT;
	219	return 0;
	220
	221	}
	222
	223	if (port->card->type == PC300_X21 &&
	224	(ifr->ifr_settings.type == IF_IFACE_SYNC_SERIAL \|\|
	225	ifr->ifr_settings.type == IF_IFACE_X21))
	226	new_type = IF_IFACE_X21;
	227
	228	else if (port->card->type == PC300_RSV &&
229	(ifr->ifr_settings.type == IF_IFACE_SYNC_SERIAL \|\|
230	ifr->ifr_settings.type == IF_IFACE_V35))
231	new_type = IF_IFACE_V35;
232
233	else if (port->card->type == PC300_RSV &&
234	ifr->ifr_settings.type == IF_IFACE_V24)
235	new_type = IF_IFACE_V24;
236
237	else
238	return hdlc_ioctl(dev, ifr, cmd);
239
240	if (!capable(CAP_NET_ADMIN))
241	return -EPERM;
242
243	if (copy_from_user(&new_line, line, size))
244	return -EFAULT;
245
246	if (new_line.clock_type != CLOCK_EXT &&
247	new_line.clock_type != CLOCK_TXFROMRX &&
248	new_line.clock_type != CLOCK_INT &&
249	new_line.clock_type != CLOCK_TXINT)
250	return -EINVAL; /* No such clock setting */
251
252	if (new_line.loopback != 0 && new_line.loopback != 1)
253	return -EINVAL;
254
255	memcpy(&port->settings, &new_line, size); /* Update settings */
256	port->iface = new_type;
257	pc300_set_iface(port);
258	return 0;
259	}
260
261
262
263	static void pc300_pci_remove_one(struct pci_dev *pdev)
264	{
265	int i;
266	card_t *card = pci_get_drvdata(pdev);
267
268	for (i = 0; i < 2; i++)
61e0a6a2 KH	269	if (card->ports[i].card)
61e0a6a2 KH	270	unregister_hdlc_device(card->ports[i].netdev);
7517c1b7 KH	271
	272	if (card->irq)
	273	free_irq(card->irq, card);
	274
	275	if (card->rambase)
	276	iounmap(card->rambase);
	277	if (card->scabase)
	278	iounmap(card->scabase);
	279	if (card->plxbase)
	280	iounmap(card->plxbase);
	281
	282	pci_release_regions(pdev);
	283	pci_disable_device(pdev);
61e0a6a2 KH	284	if (card->ports[0].netdev)
	285	free_netdev(card->ports[0].netdev);
	286	if (card->ports[1].netdev)
	287	free_netdev(card->ports[1].netdev);
7517c1b7 KH	288	kfree(card);
	289	}
	290
991990a1 KH	291	static const struct net_device_ops pc300_ops = {
	292	.ndo_open = pc300_open,
	293	.ndo_stop = pc300_close,
991990a1 KH	294	.ndo_start_xmit = hdlc_start_xmit,
	295	.ndo_do_ioctl = pc300_ioctl,
	296	};
7517c1b7	297
aeea6bbf	298	static int pc300_pci_init_one(struct pci_dev *pdev,
1dd06ae8	299	const struct pci_device_id *ent)
7517c1b7 KH	300	{
7517c1b7 KH	301	card_t *card;
7517c1b7 KH	302	u32 __iomem *p;
	303	int i;
	304	u32 ramsize;
	305	u32 ramphys; /* buffer memory base */
	306	u32 scaphys; /* SCA memory base */
	307	u32 plxphys; /* PLX registers memory base */
	308
7517c1b7 KH	309	i = pci_enable_device(pdev);
	310	if (i)
	311	return i;
	312
	313	i = pci_request_regions(pdev, "PC300");
	314	if (i) {
	315	pci_disable_device(pdev);
	316	return i;
	317	}
	318
dd00cc48	319	card = kzalloc(sizeof(card_t), GFP_KERNEL);
7517c1b7	320	if (card == NULL) {
7517c1b7 KH	321	pci_release_regions(pdev);
	322	pci_disable_device(pdev);
	323	return -ENOBUFS;
	324	}
7517c1b7 KH	325	pci_set_drvdata(pdev, card);
7517c1b7 KH	326
7517c1b7 KH	327	if (pci_resource_len(pdev, 0) != PC300_PLX_SIZE \|\|
	328	pci_resource_len(pdev, 2) != PC300_SCA_SIZE \|\|
	329	pci_resource_len(pdev, 3) < 16384) {
12a3bfef	330	pr_err("invalid card EEPROM parameters\n");
7517c1b7 KH	331	pc300_pci_remove_one(pdev);
	332	return -EFAULT;
	333	}
	334
6476a907	335	plxphys = pci_resource_start(pdev, 0) & PCI_BASE_ADDRESS_MEM_MASK;
7517c1b7 KH	336	card->plxbase = ioremap(plxphys, PC300_PLX_SIZE);
7517c1b7 KH	337
6476a907	338	scaphys = pci_resource_start(pdev, 2) & PCI_BASE_ADDRESS_MEM_MASK;
7517c1b7 KH	339	card->scabase = ioremap(scaphys, PC300_SCA_SIZE);
7517c1b7 KH	340
6476a907	341	ramphys = pci_resource_start(pdev, 3) & PCI_BASE_ADDRESS_MEM_MASK;
275f165f	342	card->rambase = pci_ioremap_bar(pdev, 3);
7517c1b7 KH	343
	344	if (card->plxbase == NULL \|\|
	345	card->scabase == NULL \|\|
	346	card->rambase == NULL) {
12a3bfef	347	pr_err("ioremap() failed\n");
7517c1b7	348	pc300_pci_remove_one(pdev);
2a39e7aa	349	return -ENOMEM;
7517c1b7 KH	350	}
	351
	352	/* PLX PCI 9050 workaround for local configuration register read bug */
	353	pci_write_config_dword(pdev, PCI_BASE_ADDRESS_0, scaphys);
184123db	354	card->init_ctrl_value = readl(&((plx9050 __iomem *)card->scabase)->init_ctrl);
7517c1b7 KH	355	pci_write_config_dword(pdev, PCI_BASE_ADDRESS_0, plxphys);
7517c1b7 KH	356
6476a907 KH	357	if (pdev->device == PCI_DEVICE_ID_PC300_TE_1 \|\|
	358	pdev->device == PCI_DEVICE_ID_PC300_TE_2)
	359	card->type = PC300_TE; /* not fully supported */
	360	else if (card->init_ctrl_value & PC300_CTYPE_MASK)
	361	card->type = PC300_X21;
	362	else
	363	card->type = PC300_RSV;
	364
	365	if (pdev->device == PCI_DEVICE_ID_PC300_RX_1 \|\|
	366	pdev->device == PCI_DEVICE_ID_PC300_TE_1)
	367	card->n_ports = 1;
	368	else
	369	card->n_ports = 2;
	370
	371	for (i = 0; i < card->n_ports; i++)
	372	if (!(card->ports[i].netdev = alloc_hdlcdev(&card->ports[i]))) {
12a3bfef	373	pr_err("unable to allocate memory\n");
6476a907 KH	374	pc300_pci_remove_one(pdev);
	375	return -ENOMEM;
	376	}
	377
7517c1b7 KH	378	/* Reset PLX */
	379	p = &card->plxbase->init_ctrl;
	380	writel(card->init_ctrl_value \| 0x40000000, p);
	381	readl(p); /* Flush the write - do not use sca_flush */
	382	udelay(1);
	383
	384	writel(card->init_ctrl_value, p);
	385	readl(p); /* Flush the write - do not use sca_flush */
	386	udelay(1);
	387
	388	/* Reload Config. Registers from EEPROM */
	389	writel(card->init_ctrl_value \| 0x20000000, p);
	390	readl(p); /* Flush the write - do not use sca_flush */
	391	udelay(1);
	392
	393	writel(card->init_ctrl_value, p);
	394	readl(p); /* Flush the write - do not use sca_flush */
	395	udelay(1);
	396
	397	ramsize = sca_detect_ram(card, card->rambase,
	398	pci_resource_len(pdev, 3));
	399
	400	if (use_crystal_clock)
	401	card->init_ctrl_value &= ~PC300_CLKSEL_MASK;
	402	else
	403	card->init_ctrl_value \|= PC300_CLKSEL_MASK;
	404
	405	writel(card->init_ctrl_value, &card->plxbase->init_ctrl);
	406	/* number of TX + RX buffers for one port */
	407	i = ramsize / (card->n_ports * (sizeof(pkt_desc) + HDLC_MAX_MRU));
	408	card->tx_ring_buffers = min(i / 2, MAX_TX_BUFFERS);
	409	card->rx_ring_buffers = i - card->tx_ring_buffers;
	410
	411	card->buff_offset = card->n_ports * sizeof(pkt_desc) *
	412	(card->tx_ring_buffers + card->rx_ring_buffers);
	413
12a3bfef JP	414	pr_info("PC300/%s, %u KB RAM at 0x%x, IRQ%u, using %u TX + %u RX packets rings\n",
	415	card->type == PC300_X21 ? "X21" :
	416	card->type == PC300_TE ? "TE" : "RSV",
	417	ramsize / 1024, ramphys, pdev->irq,
	418	card->tx_ring_buffers, card->rx_ring_buffers);
7517c1b7 KH	419
7517c1b7 KH	420	if (card->tx_ring_buffers < 1) {
12a3bfef	421	pr_err("RAM test failed\n");
7517c1b7 KH	422	pc300_pci_remove_one(pdev);
	423	return -EFAULT;
	424	}
	425
	426	/* Enable interrupts on the PCI bridge, LINTi1 active low */
	427	writew(0x0041, &card->plxbase->intr_ctrl_stat);
	428
	429	/* Allocate IRQ */
96783436	430	if (request_irq(pdev->irq, sca_intr, IRQF_SHARED, "pc300", card)) {
12a3bfef	431	pr_warn("could not allocate IRQ%d\n", pdev->irq);
7517c1b7 KH	432	pc300_pci_remove_one(pdev);
	433	return -EBUSY;
	434	}
	435	card->irq = pdev->irq;
	436
	437	sca_init(card, 0);
	438
	439	// COTE not set - allows better TX DMA settings
	440	// sca_out(sca_in(PCR, card) \| PCR_COTE, PCR, card);
	441
	442	sca_out(0x10, BTCR, card);
	443
	444	for (i = 0; i < card->n_ports; i++) {
	445	port_t *port = &card->ports[i];
61e0a6a2	446	struct net_device *dev = port->netdev;
7517c1b7	447	hdlc_device *hdlc = dev_to_hdlc(dev);
61e0a6a2	448	port->chan = i;
7517c1b7 KH	449
7517c1b7 KH	450	spin_lock_init(&port->lock);
7517c1b7 KH	451	dev->irq = card->irq;
	452	dev->mem_start = ramphys;
	453	dev->mem_end = ramphys + ramsize - 1;
	454	dev->tx_queue_len = 50;
991990a1	455	dev->netdev_ops = &pc300_ops;
7517c1b7 KH	456	hdlc->attach = sca_attach;
	457	hdlc->xmit = sca_xmit;
	458	port->settings.clock_type = CLOCK_EXT;
	459	port->card = card;
	460	if (card->type == PC300_X21)
	461	port->iface = IF_IFACE_X21;
	462	else
	463	port->iface = IF_IFACE_V35;
	464
abc9d91a	465	sca_init_port(port);
7517c1b7	466	if (register_hdlc_device(dev)) {
12a3bfef	467	pr_err("unable to register hdlc device\n");
7517c1b7 KH	468	port->card = NULL;
	469	pc300_pci_remove_one(pdev);
	470	return -ENOBUFS;
	471	}
7517c1b7	472
12a3bfef	473	netdev_info(dev, "PC300 channel %d\n", port->chan);
7517c1b7 KH	474	}
	475	return 0;
	476	}
	477
	478
	479
9baa3c34	480	static const struct pci_device_id pc300_pci_tbl[] = {
7517c1b7 KH	481	{ PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_PC300_RX_1, PCI_ANY_ID,
	482	PCI_ANY_ID, 0, 0, 0 },
	483	{ PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_PC300_RX_2, PCI_ANY_ID,
	484	PCI_ANY_ID, 0, 0, 0 },
	485	{ PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_PC300_TE_1, PCI_ANY_ID,
	486	PCI_ANY_ID, 0, 0, 0 },
	487	{ PCI_VENDOR_ID_CYCLADES, PCI_DEVICE_ID_PC300_TE_2, PCI_ANY_ID,
	488	PCI_ANY_ID, 0, 0, 0 },
	489	{ 0, }
	490	};
	491
	492
	493	static struct pci_driver pc300_pci_driver = {
184123db AV	494	.name = "PC300",
	495	.id_table = pc300_pci_tbl,
	496	.probe = pc300_pci_init_one,
	497	.remove = pc300_pci_remove_one,
7517c1b7 KH	498	};
	499
	500
	501	static int __init pc300_init_module(void)
	502	{
7517c1b7	503	if (pci_clock_freq < 1000000 \|\| pci_clock_freq > 80000000) {
12a3bfef	504	pr_err("Invalid PCI clock frequency\n");
7517c1b7 KH	505	return -EINVAL;
	506	}
	507	if (use_crystal_clock != 0 && use_crystal_clock != 1) {
12a3bfef	508	pr_err("Invalid 'use_crystal_clock' value\n");
7517c1b7 KH	509	return -EINVAL;
	510	}
	511
	512	CLOCK_BASE = use_crystal_clock ? 24576000 : pci_clock_freq;
	513
11cc3bb5	514	return pci_register_driver(&pc300_pci_driver);
7517c1b7 KH	515	}
	516
	517
	518
	519	static void __exit pc300_cleanup_module(void)
	520	{
	521	pci_unregister_driver(&pc300_pci_driver);
	522	}
	523
	524	MODULE_AUTHOR("Krzysztof Halasa <khc@pm.waw.pl>");
	525	MODULE_DESCRIPTION("Cyclades PC300 serial port driver");
	526	MODULE_LICENSE("GPL v2");
	527	MODULE_DEVICE_TABLE(pci, pc300_pci_tbl);
	528	module_param(pci_clock_freq, int, 0444);
	529	MODULE_PARM_DESC(pci_clock_freq, "System PCI clock frequency in Hz");
	530	module_param(use_crystal_clock, int, 0444);
	531	MODULE_PARM_DESC(use_crystal_clock,
	532	"Use 24.576 MHz clock instead of PCI clock");
	533	module_init(pc300_init_module);
	534	module_exit(pc300_cleanup_module);