[mirror_ubuntu-jammy-kernel.git] / drivers / net / ethernet / natsemi / xtsonic.c

// SPDX-License-Identifier: GPL-2.0
/*
 * xtsonic.c
 *
 * (C) 2001 - 2007 Tensilica Inc.
 *	Kevin Chea <kchea@yahoo.com>
 *	Marc Gauthier <marc@linux-xtensa.org>
 *	Chris Zankel <chris@zankel.net>
 *
 * (C) 1996,1998 by Thomas Bogendoerfer (tsbogend@alpha.franken.de)
 *
 * This driver is based on work from Andreas Busse, but most of
 * the code is rewritten.
 *
 * (C) 1995 by Andreas Busse (andy@waldorf-gmbh.de)
 *
 * A driver for the onboard Sonic ethernet controller on the XT2000.
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/types.h>
#include <linux/fcntl.h>
#include <linux/gfp.h>
#include <linux/interrupt.h>
#include <linux/init.h>
#include <linux/ioport.h>
#include <linux/in.h>
#include <linux/string.h>
#include <linux/delay.h>
#include <linux/errno.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/skbuff.h>
#include <linux/platform_device.h>
#include <linux/dma-mapping.h>
#include <linux/slab.h>
#include <linux/pgtable.h>

#include <asm/io.h>
#include <asm/dma.h>

static char xtsonic_string[] = "xtsonic";

extern unsigned xtboard_nvram_valid(void);
extern void xtboard_get_ether_addr(unsigned char *buf);

#include "sonic.h"

/*
 * According to the documentation for the Sonic ethernet controller,
 * EOBC should be 760 words (1520 bytes) for 32-bit applications, and,
 * as such, 2 words less than the buffer size. The value for RBSIZE
 * defined in sonic.h, however is only 1520.
 *
 * (Note that in 16-bit configurations, EOBC is 759 words (1518 bytes) and
 * RBSIZE 1520 bytes)
 */
#undef SONIC_RBSIZE
#define SONIC_RBSIZE	1524

/*
 * The chip provides 256 byte register space.
 */
#define SONIC_MEM_SIZE	0x100

/*
 * Macros to access SONIC registers
 */
#define SONIC_READ(reg) \
	(0xffff & *((volatile unsigned int *)dev->base_addr+reg))

#define SONIC_WRITE(reg,val) \
	*((volatile unsigned int *)dev->base_addr+reg) = val

/*
 * We cannot use station (ethernet) address prefixes to detect the
 * sonic controller since these are board manufacturer depended.
 * So we check for known Silicon Revision IDs instead.
 */
static unsigned short known_revisions[] =
{
	0x101,			/* SONIC 83934 */
	0xffff			/* end of list */
};

static int xtsonic_open(struct net_device *dev)
{
	int retval;

	retval = request_irq(dev->irq, sonic_interrupt, 0, "sonic", dev);
	if (retval) {
		printk(KERN_ERR "%s: unable to get IRQ %d.\n",
		       dev->name, dev->irq);
		return -EAGAIN;
	}

	retval = sonic_open(dev);
	if (retval)
		free_irq(dev->irq, dev);
	return retval;
}

static int xtsonic_close(struct net_device *dev)
{
	int err;
	err = sonic_close(dev);
	free_irq(dev->irq, dev);
	return err;
}

static const struct net_device_ops xtsonic_netdev_ops = {
	.ndo_open		= xtsonic_open,
	.ndo_stop		= xtsonic_close,
	.ndo_start_xmit		= sonic_send_packet,
	.ndo_get_stats		= sonic_get_stats,
	.ndo_set_rx_mode	= sonic_multicast_list,
	.ndo_tx_timeout		= sonic_tx_timeout,
	.ndo_validate_addr	= eth_validate_addr,
	.ndo_set_mac_address	= eth_mac_addr,
};

static int __init sonic_probe1(struct net_device *dev)
{
	unsigned int silicon_revision;
	struct sonic_local *lp = netdev_priv(dev);
	unsigned int base_addr = dev->base_addr;
	int i;
	int err = 0;

	if (!request_mem_region(base_addr, 0x100, xtsonic_string))
		return -EBUSY;

	/*
	 * get the Silicon Revision ID. If this is one of the known
	 * one assume that we found a SONIC ethernet controller at
	 * the expected location.
	 */
	silicon_revision = SONIC_READ(SONIC_SR);
	i = 0;
	while ((known_revisions[i] != 0xffff) &&
			(known_revisions[i] != silicon_revision))
		i++;

	if (known_revisions[i] == 0xffff) {
		pr_info("SONIC ethernet controller not found (0x%4x)\n",
			silicon_revision);
		return -ENODEV;
	}

	/*
	 * Put the sonic into software reset, then retrieve ethernet address.
	 * Note: we are assuming that the boot-loader has initialized the cam.
	 */
	SONIC_WRITE(SONIC_CMD,SONIC_CR_RST);
	SONIC_WRITE(SONIC_DCR,
		    SONIC_DCR_WC0|SONIC_DCR_DW|SONIC_DCR_LBR|SONIC_DCR_SBUS);
	SONIC_WRITE(SONIC_CEP,0);
	SONIC_WRITE(SONIC_IMR,0);

	SONIC_WRITE(SONIC_CMD,SONIC_CR_RST);
	SONIC_WRITE(SONIC_CEP,0);

	for (i=0; i<3; i++) {
		unsigned int val = SONIC_READ(SONIC_CAP0-i);
		dev->dev_addr[i*2] = val;
		dev->dev_addr[i*2+1] = val >> 8;
	}

	lp->dma_bitmode = SONIC_BITMODE32;

	err = sonic_alloc_descriptors(dev);
	if (err)
		goto out;

	dev->netdev_ops		= &xtsonic_netdev_ops;
	dev->watchdog_timeo	= TX_TIMEOUT;

	/*
	 * clear tally counter
	 */
	SONIC_WRITE(SONIC_CRCT,0xffff);
	SONIC_WRITE(SONIC_FAET,0xffff);
	SONIC_WRITE(SONIC_MPT,0xffff);

	return 0;
out:
	release_region(dev->base_addr, SONIC_MEM_SIZE);
	return err;
}


/*
 * Probe for a SONIC ethernet controller on an XT2000 board.
 * Actually probing is superfluous but we're paranoid.
 */

int xtsonic_probe(struct platform_device *pdev)
{
	struct net_device *dev;
	struct sonic_local *lp;
	struct resource *resmem, *resirq;
	int err = 0;

	if ((resmem = platform_get_resource(pdev, IORESOURCE_MEM, 0)) == NULL)
		return -ENODEV;

	if ((resirq = platform_get_resource(pdev, IORESOURCE_IRQ, 0)) == NULL)
		return -ENODEV;

	if ((dev = alloc_etherdev(sizeof(struct sonic_local))) == NULL)
		return -ENOMEM;

	lp = netdev_priv(dev);
	lp->device = &pdev->dev;
	platform_set_drvdata(pdev, dev);
	SET_NETDEV_DEV(dev, &pdev->dev);
	netdev_boot_setup_check(dev);

	dev->base_addr = resmem->start;
	dev->irq = resirq->start;

	if ((err = sonic_probe1(dev)))
		goto out;

	pr_info("SONIC ethernet @%08lx, MAC %pM, IRQ %d\n",
		dev->base_addr, dev->dev_addr, dev->irq);

	sonic_msg_init(dev);

	if ((err = register_netdev(dev)))
		goto out1;

	return 0;

out1:
	release_region(dev->base_addr, SONIC_MEM_SIZE);
out:
	free_netdev(dev);

	return err;
}

MODULE_DESCRIPTION("Xtensa XT2000 SONIC ethernet driver");

#include "sonic.c"

static int xtsonic_device_remove(struct platform_device *pdev)
{
	struct net_device *dev = platform_get_drvdata(pdev);
	struct sonic_local *lp = netdev_priv(dev);

	unregister_netdev(dev);
	dma_free_coherent(lp->device,
			  SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
			  lp->descriptors, lp->descriptors_laddr);
	release_region (dev->base_addr, SONIC_MEM_SIZE);
	free_netdev(dev);

	return 0;
}

static struct platform_driver xtsonic_driver = {
	.probe = xtsonic_probe,
	.remove = xtsonic_device_remove,
	.driver = {
		.name = xtsonic_string,
	},
};

module_platform_driver(xtsonic_driver);
Commit	Line	Data
b2441318	1	// SPDX-License-Identifier: GPL-2.0
74f2a5f0 CZ	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>
5a0e3ad6	24	#include <linux/gfp.h>
74f2a5f0 CZ	25	#include <linux/interrupt.h>
	26	#include <linux/init.h>
	27	#include <linux/ioport.h>
	28	#include <linux/in.h>
74f2a5f0 CZ	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>
5a0e3ad6	37	#include <linux/slab.h>
65fddcfc	38	#include <linux/pgtable.h>
74f2a5f0 CZ	39
74f2a5f0 CZ	40	#include <asm/io.h>
74f2a5f0 CZ	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
74f2a5f0 CZ	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	{
dbe000ed KV	89	int retval;
dbe000ed KV	90
d8865d5b	91	retval = request_irq(dev->irq, sonic_interrupt, 0, "sonic", dev);
dbe000ed	92	if (retval) {
74f2a5f0 CZ	93	printk(KERN_ERR "%s: unable to get IRQ %d.\n",
	94	dev->name, dev->irq);
	95	return -EAGAIN;
	96	}
dbe000ed KV	97
	98	retval = sonic_open(dev);
	99	if (retval)
	100	free_irq(dev->irq, dev);
	101	return retval;
74f2a5f0 CZ	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
ccd97bb0 AB	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,
afc4b13d	117	.ndo_set_rx_mode = sonic_multicast_list,
ccd97bb0 AB	118	.ndo_tx_timeout = sonic_tx_timeout,
ccd97bb0 AB	119	.ndo_validate_addr = eth_validate_addr,
ccd97bb0 AB	120	.ndo_set_mac_address = eth_mac_addr,
	121	};
	122
74f2a5f0 CZ	123	static int __init sonic_probe1(struct net_device *dev)
74f2a5f0 CZ	124	{
74f2a5f0 CZ	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
	131	if (!request_mem_region(base_addr, 0x100, xtsonic_string))
	132	return -EBUSY;
	133
	134	/*
	135	* get the Silicon Revision ID. If this is one of the known
	136	* one assume that we found a SONIC ethernet controller at
	137	* the expected location.
	138	*/
	139	silicon_revision = SONIC_READ(SONIC_SR);
74f2a5f0 CZ	140	i = 0;
	141	while ((known_revisions[i] != 0xffff) &&
	142	(known_revisions[i] != silicon_revision))
	143	i++;
	144
	145	if (known_revisions[i] == 0xffff) {
bbc2f23a FT	146	pr_info("SONIC ethernet controller not found (0x%4x)\n",
bbc2f23a FT	147	silicon_revision);
74f2a5f0 CZ	148	return -ENODEV;
	149	}
	150
74f2a5f0 CZ	151	/*
	152	* Put the sonic into software reset, then retrieve ethernet address.
	153	* Note: we are assuming that the boot-loader has initialized the cam.
	154	*/
	155	SONIC_WRITE(SONIC_CMD,SONIC_CR_RST);
	156	SONIC_WRITE(SONIC_DCR,
	157	SONIC_DCR_WC0\|SONIC_DCR_DW\|SONIC_DCR_LBR\|SONIC_DCR_SBUS);
	158	SONIC_WRITE(SONIC_CEP,0);
	159	SONIC_WRITE(SONIC_IMR,0);
	160
	161	SONIC_WRITE(SONIC_CMD,SONIC_CR_RST);
	162	SONIC_WRITE(SONIC_CEP,0);
	163
	164	for (i=0; i<3; i++) {
	165	unsigned int val = SONIC_READ(SONIC_CAP0-i);
	166	dev->dev_addr[i*2] = val;
	167	dev->dev_addr[i*2+1] = val >> 8;
	168	}
	169
74f2a5f0 CZ	170	lp->dma_bitmode = SONIC_BITMODE32;
74f2a5f0 CZ	171
5d58c21c FT	172	err = sonic_alloc_descriptors(dev);
5d58c21c FT	173	if (err)
74f2a5f0	174	goto out;
74f2a5f0	175
ccd97bb0	176	dev->netdev_ops = &xtsonic_netdev_ops;
74f2a5f0 CZ	177	dev->watchdog_timeo = TX_TIMEOUT;
	178
	179	/*
	180	* clear tally counter
	181	*/
	182	SONIC_WRITE(SONIC_CRCT,0xffff);
	183	SONIC_WRITE(SONIC_FAET,0xffff);
	184	SONIC_WRITE(SONIC_MPT,0xffff);
	185
	186	return 0;
	187	out:
	188	release_region(dev->base_addr, SONIC_MEM_SIZE);
	189	return err;
	190	}
	191
	192
	193	/*
	194	* Probe for a SONIC ethernet controller on an XT2000 board.
	195	* Actually probing is superfluous but we're paranoid.
	196	*/
	197
6980cbe4	198	int xtsonic_probe(struct platform_device *pdev)
74f2a5f0 CZ	199	{
	200	struct net_device *dev;
	201	struct sonic_local *lp;
	202	struct resource resmem, resirq;
	203	int err = 0;
	204
74f2a5f0 CZ	205	if ((resmem = platform_get_resource(pdev, IORESOURCE_MEM, 0)) == NULL)
	206	return -ENODEV;
	207
	208	if ((resirq = platform_get_resource(pdev, IORESOURCE_IRQ, 0)) == NULL)
	209	return -ENODEV;
	210
	211	if ((dev = alloc_etherdev(sizeof(struct sonic_local))) == NULL)
	212	return -ENOMEM;
	213
	214	lp = netdev_priv(dev);
	215	lp->device = &pdev->dev;
8724be0e	216	platform_set_drvdata(pdev, dev);
74f2a5f0 CZ	217	SET_NETDEV_DEV(dev, &pdev->dev);
	218	netdev_boot_setup_check(dev);
	219
	220	dev->base_addr = resmem->start;
	221	dev->irq = resirq->start;
	222
	223	if ((err = sonic_probe1(dev)))
	224	goto out;
bbc2f23a FT	225
	226	pr_info("SONIC ethernet @%08lx, MAC %pM, IRQ %d\n",
	227	dev->base_addr, dev->dev_addr, dev->irq);
	228
995b2a65 FT	229	sonic_msg_init(dev);
995b2a65 FT	230
74f2a5f0 CZ	231	if ((err = register_netdev(dev)))
	232	goto out1;
	233
74f2a5f0 CZ	234	return 0;
	235
	236	out1:
	237	release_region(dev->base_addr, SONIC_MEM_SIZE);
	238	out:
	239	free_netdev(dev);
	240
	241	return err;
	242	}
	243
	244	MODULE_DESCRIPTION("Xtensa XT2000 SONIC ethernet driver");
74f2a5f0 CZ	245
	246	#include "sonic.c"
	247
6980cbe4	248	static int xtsonic_device_remove(struct platform_device *pdev)
74f2a5f0 CZ	249	{
	250	struct net_device *dev = platform_get_drvdata(pdev);
	251	struct sonic_local *lp = netdev_priv(dev);
	252
	253	unregister_netdev(dev);
	254	dma_free_coherent(lp->device,
	255	SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
	256	lp->descriptors, lp->descriptors_laddr);
	257	release_region (dev->base_addr, SONIC_MEM_SIZE);
	258	free_netdev(dev);
	259
	260	return 0;
	261	}
	262
	263	static struct platform_driver xtsonic_driver = {
	264	.probe = xtsonic_probe,
6980cbe4	265	.remove = xtsonic_device_remove,
74f2a5f0 CZ	266	.driver = {
	267	.name = xtsonic_string,
	268	},
	269	};
	270
db62f684	271	module_platform_driver(xtsonic_driver);