Commit 204a38ab authored by Joe Perches's avatar Joe Perches Committed by David S. Miller
Browse files

cirrus: cs89x0: Code style neatening 



Neaten the comments and reflow the code without
changing anything other than whitespace.

git diff -w shows just comment neatening and a few
line removals.

Signed-off-by: default avatarJoe Perches <joe@perches.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 941a77d5

drivers/net/ethernet/cirrus/cs89x0.c

+323 −411
Original line number Diff line number Diff line 
/* cs89x0.c: A Crystal Semiconductor (Now Cirrus Logic) CS89[02]0

 *           driver for linux.

 */



/*

	Written 1996 by Russell Nelson, with reference to skeleton.c

	written 1993-1994 by Donald Becker.



	This software may be used and distributed according to the terms

	of the GNU General Public License, incorporated herein by reference.



        The author may be reached at nelson@crynwr.com, Crynwr

        Software, 521 Pleasant Valley Rd., Potsdam, NY 13676



  Changelog:



  Mike Cruse        : mcruse@cti-ltd.com

                    : Changes for Linux 2.0 compatibility.

                    : Added dev_id parameter in net_interrupt(),

                    : request_irq() and free_irq(). Just NULL for now.



  Mike Cruse        : Added MOD_INC_USE_COUNT and MOD_DEC_USE_COUNT macros

                    : in net_open() and net_close() so kerneld would know

                    : that the module is in use and wouldn't eject the

                    : driver prematurely.



  Mike Cruse        : Rewrote init_module() and cleanup_module using 8390.c

                    : as an example. Disabled autoprobing in init_module(),

                    : not a good thing to do to other devices while Linux

                    : is running from all accounts.



  Russ Nelson       : Jul 13 1998.  Added RxOnly DMA support.



  Melody Lee        : Aug 10 1999.  Changes for Linux 2.2.5 compatibility.

                    : email: ethernet@crystal.cirrus.com



  Alan Cox          : Removed 1.2 support, added 2.1 extra counters.



  Andrew Morton     : Kernel 2.3.48

                    : Handle kmalloc() failures

                    : Other resource allocation fixes

                    : Add SMP locks

                    : Integrate Russ Nelson's ALLOW_DMA functionality back in.

                    : If ALLOW_DMA is true, make DMA runtime selectable

                    : Folded in changes from Cirrus (Melody Lee

                    : <klee@crystal.cirrus.com>)

                    : Don't call netif_wake_queue() in net_send_packet()

                    : Fixed an out-of-mem bug in dma_rx()

                    : Updated Documentation/networking/cs89x0.txt



  Andrew Morton     : Kernel 2.3.99-pre1

                    : Use skb_reserve to longword align IP header (two places)

                    : Remove a delay loop from dma_rx()

                    : Replace '100' with HZ

                    : Clean up a couple of skb API abuses

                    : Added 'cs89x0_dma=N' kernel boot option

                    : Correctly initialise lp->lock in non-module compile



  Andrew Morton     : Kernel 2.3.99-pre4-1

                    : MOD_INC/DEC race fix (see

                    : http://www.uwsg.indiana.edu/hypermail/linux/kernel/0003.3/1532.html)



  Andrew Morton     : Kernel 2.4.0-test7-pre2

                    : Enhanced EEPROM support to cover more devices,

                    :   abstracted IRQ mapping to support CONFIG_ARCH_CLPS7500 arch

                    :   (Jason Gunthorpe <jgg@ualberta.ca>)



  Andrew Morton     : Kernel 2.4.0-test11-pre4

                    : Use dev->name in request_*() (Andrey Panin)

                    : Fix an error-path memleak in init_module()

                    : Preserve return value from request_irq()

                    : Fix type of `media' module parm (Keith Owens)

                    : Use SET_MODULE_OWNER()

                    : Tidied up strange request_irq() abuse in net_open().



  Andrew Morton     : Kernel 2.4.3-pre1

                    : Request correct number of pages for DMA (Hugh Dickens)

                    : Select PP_ChipID _after_ unregister_netdev in cleanup_module()

                    :  because unregister_netdev() calls get_stats.

                    : Make `version[]' __initdata

                    : Uninlined the read/write reg/word functions.



  Oskar Schirmer    : oskar@scara.com

                    : HiCO.SH4 (superh) support added (irq#1, cs89x0_media=)



  Deepak Saxena     : dsaxena@plexity.net

                    : Intel IXDP2x01 (XScale ixp2x00 NPU) platform support



  Dmitry Pervushin  : dpervushin@ru.mvista.com

                    : PNX010X platform support



  Deepak Saxena     : dsaxena@plexity.net

                    : Intel IXDP2351 platform support



  Dmitry Pervushin  : dpervushin@ru.mvista.com

                    : PNX010X platform support



  Domenico Andreoli : cavokz@gmail.com

                    : QQ2440 platform support



 * Written 1996 by Russell Nelson, with reference to skeleton.c

 * written 1993-1994 by Donald Becker.

 *

 * This software may be used and distributed according to the terms

 * of the GNU General Public License, incorporated herein by reference.

 *

 * The author may be reached at nelson@crynwr.com, Crynwr

 * Software, 521 Pleasant Valley Rd., Potsdam, NY 13676

 *

 * Other contributors:

 * Mike Cruse        : mcruse@cti-ltd.com

 * Russ Nelson

 * Melody Lee        : ethernet@crystal.cirrus.com

 * Alan Cox

 * Andrew Morton

 * Oskar Schirmer    : oskar@scara.com

 * Deepak Saxena     : dsaxena@plexity.net

 * Dmitry Pervushin  : dpervushin@ru.mvista.com

 * Deepak Saxena     : dsaxena@plexity.net

 * Domenico Andreoli : cavokz@gmail.com

 */
@@ -119,13 +41,9 @@ 
 */

#define DEBUGGING	1



/*

  Sources:



	Crynwr packet driver epktisa.



	Crystal Semiconductor data sheets.



/* Sources:

 *	Crynwr packet driver epktisa.

 *	Crystal Semiconductor data sheets.

 */



#include <linux/module.h>
@@ -163,16 +81,18 @@ static char version[] __initdata = 
#define DRV_NAME "cs89x0"



/* First, a few definitions that the brave might change.

   A zero-terminated list of I/O addresses to be probed. Some special flags..

      Addr & 1 = Read back the address port, look for signature and reset

                 the page window before probing

      Addr & 3 = Reset the page window and probe

   The CLPS eval board has the Cirrus chip at 0x80090300, in ARM IO space,

   but it is possible that a Cirrus board could be plugged into the ISA

   slots. */

 * A zero-terminated list of I/O addresses to be probed. Some special flags..

 * Addr & 1 = Read back the address port, look for signature and reset

 * the page window before probing

 * Addr & 3 = Reset the page window and probe

 * The CLPS eval board has the Cirrus chip at 0x80090300, in ARM IO space,

 * but it is possible that a Cirrus board could be plugged into the ISA

 * slots.

 */

/* The cs8900 has 4 IRQ pins, software selectable. cs8900_irq_map maps

   them to system IRQ numbers. This mapping is card specific and is set to

   the configuration of the Cirrus Eval board for this chip. */

 * them to system IRQ numbers. This mapping is card specific and is set to

 * the configuration of the Cirrus Eval board for this chip.

 */

#if defined(CONFIG_MACH_IXDP2351)

#define CS89x0_NONISA_IRQ

static unsigned int netcard_portlist[] __used __initdata = {IXDP2351_VIRT_CS8900_BASE, 0};
@@ -362,9 +282,10 @@ static int __init 
wait_eeprom_ready(struct net_device *dev)

{

	int timeout = jiffies;

	/* check to see if the EEPROM is ready, a timeout is used -

	   just in case EEPROM is ready when SI_BUSY in the

	   PP_SelfST is clear */

	/* check to see if the EEPROM is ready,

	 * a timeout is used just in case EEPROM is ready when

	 * SI_BUSY in the PP_SelfST is clear

	 */

	while (readreg(dev, PP_SelfST) & SI_BUSY)

		if (jiffies - timeout >= 40)

			return -1;
@@ -431,12 +352,12 @@ static const struct net_device_ops net_ops = { 
	.ndo_validate_addr	= eth_validate_addr,

};



/* This is the real probe routine.  Linux has a history of friendly device

   probes on the ISA bus.  A good device probes avoids doing writes, and

   verifies that the correct device exists and functions.

   Return 0 on success.

/* This is the real probe routine.

 * Linux has a history of friendly device probes on the ISA bus.

 * A good device probes avoids doing writes, and

 * verifies that the correct device exists and functions.

 * Return 0 on success.

 */



static int __init

cs89x0_probe1(struct net_device *dev, void __iomem *ioaddr, int modular)

{
@@ -504,13 +425,13 @@ cs89x0_probe1(struct net_device *dev, void __iomem *ioaddr, int modular) 


	reset_chip(dev);



        /* Here we read the current configuration of the chip. If there

	   is no Extended EEPROM then the idea is to not disturb the chip

	   configuration, it should have been correctly setup by automatic

	   EEPROM read on reset. So, if the chip says it read the EEPROM

	   the driver will always do *something* instead of complain that

	   adapter_cnf is 0. */



	/* Here we read the current configuration of the chip.

	 * If there is no Extended EEPROM then the idea is to not disturb

	 * the chip configuration, it should have been correctly setup by

	 * automatic EEPROM read on reset. So, if the chip says it read

	 * the EEPROM the driver will always do *something* instead of

	 * complain that adapter_cnf is 0.

	 */



	if ((readreg(dev, PP_SelfST) & (EEPROM_OK | EEPROM_PRESENT)) ==

	    (EEPROM_OK|EEPROM_PRESENT)) {
@@ -523,14 +444,15 @@ cs89x0_probe1(struct net_device *dev, void __iomem *ioaddr, int modular) 
		}



		/* Load the Adapter Configuration.

		   Note:  Barring any more specific information from some

		   other source (ie EEPROM+Schematics), we would not know

		   how to operate a 10Base2 interface on the AUI port.

		   However, since we  do read the status of HCB1 and use

		   settings that always result in calls to control_dc_dc(dev,0)

		   a BNC interface should work if the enable pin

		   (dc/dc converter) is on HCB1. It will be called AUI

		   however. */

		 * Note:  Barring any more specific information from some

		 * other source (ie EEPROM+Schematics), we would not know

		 * how to operate a 10Base2 interface on the AUI port.

		 * However, since we  do read the status of HCB1 and use

		 * settings that always result in calls to control_dc_dc(dev,0)

		 * a BNC interface should work if the enable pin

		 * (dc/dc converter) is on HCB1.

		 * It will be called AUI however.

		 */



		lp->adapter_cnf = 0;

		i = readreg(dev, PP_LineCTL);
@@ -579,7 +501,8 @@ cs89x0_probe1(struct net_device *dev, void __iomem *ioaddr, int modular) 


	} else {

		/* This reads an extended EEPROM that is not documented

		   in the CS8900 datasheet. */

		 * in the CS8900 datasheet.

		 */



		/* get transmission control word  but keep the autonegotiation bits */

		if (!lp->auto_neg_cnf) lp->auto_neg_cnf = eeprom_buff[AUTO_NEG_CNF_OFFSET/2];
@@ -621,7 +544,8 @@ cs89x0_probe1(struct net_device *dev, void __iomem *ioaddr, int modular) 
	/* FIXME: We don't let you set the IMM bit from the command line: add it to lp->auto_neg_cnf here */



	/* FIXME: we don't set the Ethernet address on the command line.  Use

           ifconfig IFACE hw ether AABBCCDDEEFF */

	 * ifconfig IFACE hw ether AABBCCDDEEFF

	 */



	printk(KERN_INFO "cs89x0 media %s%s%s",

	       (lp->adapter_cnf & A_CNF_10B_T) ? "RJ-45," : "",
@@ -730,9 +654,10 @@ cs89x0_ioport_probe(struct net_device *dev, unsigned long ioport, int modular) 
	}



	/* if they give us an odd I/O address, then do ONE write to

	   the address port, to get it back to address zero, where we

	   expect to find the EISA signature word. An IO with a base of 0x3

	   will skip the test for the ADD_PORT. */

	 * the address port, to get it back to address zero, where we

	 * expect to find the EISA signature word. An IO with a base of 0x3

	 * will skip the test for the ADD_PORT.

	 */

	if (ioport & 1) {

		if (net_debug > 1)

			printk(KERN_INFO "%s: odd ioaddr 0x%lx\n",
@@ -762,11 +687,11 @@ out: 


#ifndef MODULE

/* Check for a network adaptor of this type, and return '0' iff one exists.

   If dev->base_addr == 0, probe all likely locations.

   If dev->base_addr == 1, always return failure.

   If dev->base_addr == 2, allocate space for the device and return success

   (detachable devices only).

   Return 0 on success.

 * If dev->base_addr == 0, probe all likely locations.

 * If dev->base_addr == 1, always return failure.

 * If dev->base_addr == 2, allocate space for the device and return success

 * (detachable devices only).

 * Return 0 on success.

 */



struct net_device * __init cs89x0_probe(int unit)
@@ -814,7 +739,7 @@ out: 


/*********************************

 * This page contains DMA routines

**********************************/

 *********************************/



#if ALLOW_DMA
@@ -1479,8 +1404,7 @@ static netdev_tx_t net_send_packet(struct sk_buff *skb,struct net_device *dev) 


	/* Test to see if the chip has allocated memory for the packet */

	if ((readreg(dev, PP_BusST) & READY_FOR_TX_NOW) == 0) {

		/*

		 * Gasp!  It hasn't.  But that shouldn't happen since

		/* Gasp!  It hasn't.  But that shouldn't happen since

		 * we're waiting for TxOk, so return 1 and requeue this packet.

		 */
@@ -1494,8 +1418,7 @@ static netdev_tx_t net_send_packet(struct sk_buff *skb,struct net_device *dev) 
	dev->stats.tx_bytes += skb->len;

	dev_kfree_skb(skb);



	/*

	 * We DO NOT call netif_wake_queue() here.

	/* We DO NOT call netif_wake_queue() here.

	 * We also DO NOT call netif_start_queue().

	 *

	 * Either of these would cause another bottom half run through
@@ -1509,7 +1432,8 @@ static netdev_tx_t net_send_packet(struct sk_buff *skb,struct net_device *dev) 
}



/* The typical workload of the driver:

   Handle the network interface interrupts. */

 * Handle the network interface interrupts.

 */



static irqreturn_t net_interrupt(int irq, void *dev_id)

{
@@ -1521,12 +1445,13 @@ static irqreturn_t net_interrupt(int irq, void *dev_id) 
	lp = netdev_priv(dev);



	/* we MUST read all the events out of the ISQ, otherwise we'll never

           get interrupted again.  As a consequence, we can't have any limit

           on the number of times we loop in the interrupt handler.  The

           hardware guarantees that eventually we'll run out of events.  Of

           course, if you're on a slow machine, and packets are arriving

           faster than you can read them off, you're screwed.  Hasta la

           vista, baby!  */

	 * get interrupted again.  As a consequence, we can't have any limit

	 * on the number of times we loop in the interrupt handler.  The

	 * hardware guarantees that eventually we'll run out of events.  Of

	 * course, if you're on a slow machine, and packets are arriving

	 * faster than you can read them off, you're screwed.  Hasta la

	 * vista, baby!

	 */

	while ((status = ioread16(lp->virt_addr + ISQ_PORT))) {

		if (net_debug > 4)printk("%s: event=%04x\n", dev->name, status);

		handled = 1;
@@ -1558,10 +1483,11 @@ static irqreturn_t net_interrupt(int irq, void *dev_id) 
		case ISQ_BUFFER_EVENT:

			if (status & READY_FOR_TX) {

				/* we tried to transmit a packet earlier,

                                   but inexplicably ran out of buffers.

                                   That shouldn't happen since we only ever

                                   load one packet.  Shrug.  Do the right

                                   thing anyway. */

				 * but inexplicably ran out of buffers.

				 * That shouldn't happen since we only ever

				 * load one packet.  Shrug.  Do the right

				 * thing anyway.

				 */

				netif_wake_queue(dev);	/* Inform upper layers. */

			}

			if (status & TX_UNDERRUN) {
@@ -1570,10 +1496,11 @@ static irqreturn_t net_interrupt(int irq, void *dev_id) 
				if (lp->send_underrun == 3) lp->send_cmd = TX_AFTER_381;

				else if (lp->send_underrun == 6) lp->send_cmd = TX_AFTER_ALL;

				/* transmit cycle is done, although

				   frame wasn't transmitted - this

				   avoids having to wait for the upper

				   layers to timeout on us, in the

				   event of a tx underrun */

				 * frame wasn't transmitted - this

				 * avoids having to wait for the upper

				 * layers to timeout on us, in the

				 * event of a tx underrun

				 */

				netif_wake_queue(dev);	/* Inform upper layers. */

			}

#if ALLOW_DMA
@@ -1700,8 +1627,9 @@ net_close(struct net_device *dev) 
	return 0;

}



/* Get the current statistics.	This may be called with the card open or

   closed. */

/* Get the current statistics.

 * This may be called with the card open or closed.

 */

static struct net_device_stats *

net_get_stats(struct net_device *dev)

{
@@ -1770,8 +1698,7 @@ static int set_mac_address(struct net_device *dev, void *p) 


static struct net_device *dev_cs89x0;



/*

 * Support the 'debug' module parm even if we're compiled for non-debug to

/* Support the 'debug' module parm even if we're compiled for non-debug to

 * avoid breaking someone's startup scripts

 */
@@ -1816,16 +1743,14 @@ MODULE_PARM_DESC(use_dma , "(ignored)"); 
MODULE_AUTHOR("Mike Cruse, Russwll Nelson <nelson@crynwr.com>, Andrew Morton");

MODULE_LICENSE("GPL");





/*

 * media=t             - specify media type

   or media=2

   or media=aui

   or medai=auto

 * or media=2

 * or media=aui

 * or medai=auto

 * duplex=0            - specify forced half/full/autonegotiate duplex

 * debug=#             - debug level





 *

 * Default Chip Configuration:

 * DMA Burst = enabled

 * IOCHRDY Enabled = enabled
@@ -1833,14 +1758,12 @@ MODULE_LICENSE("GPL"); 
 * CS8900 defaults to half-duplex if not specified on command-line

 * CS8920 defaults to autoneg if not specified on command-line

 * Use reset defaults for other config parameters



 *

 * Assumptions:

 * media type specified is supported (circuitry is present)

 * if memory address is > 1MB, then required mem decode hw is present

 * if 10B-2, then agent other than driver will enable DC/DC converter

    (hw or software util)





 * (hw or software util)

 */



int __init init_module(void)
@@ -1985,8 +1908,7 @@ static int cs89x0_platform_remove(struct platform_device *pdev) 
	struct net_local *lp = netdev_priv(dev);

	struct resource *mem_res;



	/*

	 * This platform_get_resource() call will not return NULL, because

	/* This platform_get_resource() call will not return NULL, because

	 * the same call in cs89x0_platform_probe() has returned a non NULL

	 * value.

	 */
@@ -2021,13 +1943,3 @@ static void __exit cs89x0_cleanup(void) 
module_exit(cs89x0_cleanup);



#endif /* CONFIG_CS89x0_PLATFORM */
 


/*

 * Local variables:

 *  version-control: t

 *  kept-new-versions: 5

 *  c-indent-level: 8

 *  tab-width: 8

 * End:

 *

 */