1 /*------------------------------------------------------------------------
3 * This is a driver for SMSC's LAN91C96 single-chip Ethernet device, based
4 * on the SMC91111 driver from U-boot.
7 * Sysgo Real-Time Solutions, GmbH <www.elinos.com>
8 * Rolf Offermanns <rof@sysgo.de>
10 * Copyright (C) 2001 Standard Microsystems Corporation (SMSC)
11 * Developed by Simple Network Magic Corporation (SNMC)
12 * Copyright (C) 1996 by Erik Stahlman (ES)
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
28 * Information contained in this file was obtained from the LAN91C96
29 * manual from SMC. To get a copy, if you really want one, you can find
30 * information under www.smsc.com.
33 * "Features" of the SMC chip:
34 * 6144 byte packet memory. ( for the 91C96 )
35 * EEPROM for configuration
36 * AUI/TP selection ( mine has 10Base2/10BaseT select )
39 * io = for the base address
43 * Erik Stahlman ( erik@vt.edu )
44 * Daris A Nevil ( dnevil@snmc.com )
47 * Hardware multicast code from Peter Cammaert ( pc@denkart.be )
50 * o SMSC LAN91C96 databook (www.smsc.com)
51 * o smc91111.c (u-boot driver)
52 * o smc9194.c (linux kernel driver)
53 * o lan91c96.c (Intel Diagnostic Manager driver)
56 * 04/30/03 Mathijs Haarman Modified smc91111.c (u-boot version)
58 *---------------------------------------------------------------------------
66 /*------------------------------------------------------------------------
68 * Configuration options, for the experienced user to change.
70 -------------------------------------------------------------------------*/
72 /* Use power-down feature of the chip */
76 * Wait time for memory to be free. This probably shouldn't be
77 * tuned that much, as waiting for this means nothing else happens
80 #define MEMORY_WAIT_TIME 16
85 #define PRINTK3(args...) printf(args)
87 #define PRINTK3(args...)
91 #define PRINTK2(args...) printf(args)
93 #define PRINTK2(args...)
97 #define PRINTK(args...) printf(args)
99 #define PRINTK(args...)
103 /*------------------------------------------------------------------------
105 * The internal workings of the driver. If you are changing anything
106 * here with the SMC stuff, you should have the datasheet and know
107 * what you are doing.
109 *------------------------------------------------------------------------
111 #define CARDNAME "LAN91C96"
113 #define SMC_BASE_ADDRESS CONFIG_LAN91C96_BASE
115 #define SMC_DEV_NAME "LAN91C96"
116 #define SMC_ALLOC_MAX_TRY 5
117 #define SMC_TX_TIMEOUT 30
121 #ifdef CONFIG_LAN91C96_USE_32_BIT
127 /*-----------------------------------------------------------------
129 * The driver can be entered at any of the following entry points.
131 *-----------------------------------------------------------------
134 extern int eth_init (bd_t * bd);
135 extern void eth_halt (void);
136 extern int eth_rx (void);
137 extern int eth_send (volatile void *packet, int length);
139 static int smc_hw_init (void);
143 * This is called by register_netdev(). It is responsible for
144 * checking the portlist for the SMC9000 series chipset. If it finds
145 * one, then it will initialize the device, find the hardware information,
146 * and sets up the appropriate device parameters.
147 * NOTE: Interrupts are *OFF* when this procedure is called.
149 * NB:This shouldn't be static since it is referred to externally.
154 * This is called by unregister_netdev(). It is responsible for
155 * cleaning up before the driver is finally unregistered and discarded.
157 void smc_destructor (void);
160 * The kernel calls this function when someone wants to use the device,
161 * typically 'ifconfig ethX up'.
163 static int smc_open (bd_t *bd);
167 * This is called by the kernel in response to 'ifconfig ethX down'. It
168 * is responsible for cleaning up everything that the open routine
169 * does, and maybe putting the card into a powerdown state.
171 static int smc_close (void);
174 * This is a separate procedure to handle the receipt of a packet, to
175 * leave the interrupt code looking slightly cleaner
177 static int smc_rcv (void);
179 /* See if a MAC address is defined in the current environment. If so use it. If not
180 . print a warning and set the environment and other globals with the default.
181 . If an EEPROM is present it really should be consulted.
183 int smc_get_ethaddr(bd_t *bd);
184 int get_rom_mac(unsigned char *v_rom_mac);
186 /* ------------------------------------------------------------
188 * ------------------------------------------------------------
191 static unsigned char smc_mac_addr[] = { 0xc0, 0x00, 0x00, 0x1b, 0x62, 0x9c };
194 * This function must be called before smc_open() if you want to override
195 * the default mac address.
198 void smc_set_mac_addr (const unsigned char *addr)
202 for (i = 0; i < sizeof (smc_mac_addr); i++) {
203 smc_mac_addr[i] = addr[i];
208 * smc_get_macaddr is no longer used. If you want to override the default
209 * mac address, call smc_get_mac_addr as a part of the board initialisation.
213 void smc_get_macaddr (byte * addr)
215 /* MAC ADDRESS AT FLASHBLOCK 1 / OFFSET 0x10 */
216 unsigned char *dnp1110_mac = (unsigned char *) (0xE8000000 + 0x20010);
220 for (i = 0; i < 6; i++) {
221 addr[0] = *(dnp1110_mac + 0);
222 addr[1] = *(dnp1110_mac + 1);
223 addr[2] = *(dnp1110_mac + 2);
224 addr[3] = *(dnp1110_mac + 3);
225 addr[4] = *(dnp1110_mac + 4);
226 addr[5] = *(dnp1110_mac + 5);
231 /***********************************************
232 * Show available memory *
233 ***********************************************/
234 void dump_memory_info (void)
239 old_bank = SMC_inw (LAN91C96_BANK_SELECT) & 0xF;
242 mem_info = SMC_inw (LAN91C96_MIR);
243 PRINTK2 ("Memory: %4d available\n", (mem_info >> 8) * 2048);
245 SMC_SELECT_BANK (old_bank);
249 * A rather simple routine to print out a packet for debugging purposes.
252 static void print_packet (byte *, int);
255 /* #define tx_done(dev) 1 */
258 /* this does a soft reset on the device */
259 static void smc_reset (void);
261 /* Enable Interrupts, Receive, and Transmit */
262 static void smc_enable (void);
264 /* this puts the device in an inactive state */
265 static void smc_shutdown (void);
268 static int poll4int (byte mask, int timeout)
270 int tmo = get_timer (0) + timeout * CONFIG_SYS_HZ;
272 word old_bank = SMC_inw (LAN91C96_BANK_SELECT);
274 PRINTK2 ("Polling...\n");
276 while ((SMC_inw (LAN91C96_INT_STATS) & mask) == 0) {
277 if (get_timer (0) >= tmo) {
283 /* restore old bank selection */
284 SMC_SELECT_BANK (old_bank);
293 * Function: smc_reset( void )
295 * This sets the SMC91111 chip to its normal state, hopefully from whatever
296 * mess that any other DOS driver has put it in.
298 * Maybe I should reset more registers to defaults in here? SOFTRST should
302 * 1. send a SOFT RESET
303 * 2. wait for it to finish
304 * 3. enable autorelease mode
305 * 4. reset the memory management unit
306 * 5. clear all interrupts
309 static void smc_reset (void)
311 PRINTK2 ("%s:smc_reset\n", SMC_DEV_NAME);
313 /* This resets the registers mostly to defaults, but doesn't
314 affect EEPROM. That seems unnecessary */
316 SMC_outw (LAN91C96_RCR_SOFT_RST, LAN91C96_RCR);
320 /* Disable transmit and receive functionality */
321 SMC_outw (0, LAN91C96_RCR);
322 SMC_outw (0, LAN91C96_TCR);
324 /* set the control register */
326 SMC_outw (SMC_inw (LAN91C96_CONTROL) | LAN91C96_CTR_BIT_8,
329 /* Disable all interrupts */
330 SMC_outb (0, LAN91C96_INT_MASK);
334 * Function: smc_enable
335 * Purpose: let the chip talk to the outside work
337 * 1. Initialize the Memory Configuration Register
338 * 2. Enable the transmitter
339 * 3. Enable the receiver
341 static void smc_enable ()
343 PRINTK2 ("%s:smc_enable\n", SMC_DEV_NAME);
346 /* Initialize the Memory Configuration Register. See page
347 49 of the LAN91C96 data sheet for details. */
348 SMC_outw (LAN91C96_MCR_TRANSMIT_PAGES, LAN91C96_MCR);
350 /* Initialize the Transmit Control Register */
351 SMC_outw (LAN91C96_TCR_TXENA, LAN91C96_TCR);
352 /* Initialize the Receive Control Register
354 * The promiscuous bit set because I could not receive ARP reply
355 * packets from the server when I send a ARP request. It only works
356 * when I set the promiscuous bit
358 SMC_outw (LAN91C96_RCR_RXEN | LAN91C96_RCR_PRMS, LAN91C96_RCR);
362 * Function: smc_shutdown
363 * Purpose: closes down the SMC91xxx chip.
365 * 1. zero the interrupt mask
366 * 2. clear the enable receive flag
367 * 3. clear the enable xmit flags
370 * (1) maybe utilize power down mode.
371 * Why not yet? Because while the chip will go into power down mode,
372 * the manual says that it will wake up in response to any I/O requests
373 * in the register space. Empirical results do not show this working.
375 static void smc_shutdown ()
377 PRINTK2 (CARDNAME ":smc_shutdown\n");
379 /* no more interrupts for me */
381 SMC_outb (0, LAN91C96_INT_MASK);
383 /* and tell the card to stay away from that nasty outside world */
385 SMC_outb (0, LAN91C96_RCR);
386 SMC_outb (0, LAN91C96_TCR);
391 * Function: smc_hardware_send_packet(struct net_device * )
393 * This sends the actual packet to the SMC9xxx chip.
396 * First, see if a saved_skb is available.
397 * ( this should NOT be called if there is no 'saved_skb'
398 * Now, find the packet number that the chip allocated
399 * Point the data pointers at it in memory
400 * Set the length word in the chip's memory
401 * Dump the packet to chip memory
402 * Check if a last byte is needed ( odd length packet )
403 * if so, set the control flag right
404 * Tell the card to send it
405 * Enable the transmit interrupt, so I know if it failed
406 * Free the kernel data if I actually sent it.
408 static int smc_send_packet (volatile void *packet, int packet_length)
411 unsigned long ioaddr;
420 PRINTK3 ("%s:smc_hardware_send_packet\n", SMC_DEV_NAME);
422 length = ETH_ZLEN < packet_length ? packet_length : ETH_ZLEN;
425 ** The MMU wants the number of pages to be the number of 256 bytes
426 ** 'pages', minus 1 ( since a packet can't ever have 0 pages :) )
428 ** The 91C111 ignores the size bits, but the code is left intact
429 ** for backwards and future compatibility.
431 ** Pkt size for allocating is data length +6 (for additional status
432 ** words, length and ctl!)
434 ** If odd size then last byte is included in this header.
436 numPages = ((length & 0xfffe) + 6);
437 numPages >>= 8; /* Divide by 256 */
440 printf ("%s: Far too big packet error. \n", SMC_DEV_NAME);
444 /* now, try to allocate the memory */
447 SMC_outw (LAN91C96_MMUCR_ALLOC_TX | numPages, LAN91C96_MMU);
451 time_out = MEMORY_WAIT_TIME;
453 status = SMC_inb (LAN91C96_INT_STATS);
454 if (status & LAN91C96_IST_ALLOC_INT) {
456 SMC_outb (LAN91C96_IST_ALLOC_INT, LAN91C96_INT_STATS);
459 } while (--time_out);
462 PRINTK2 ("%s: memory allocation, try %d failed ...\n",
464 if (try < SMC_ALLOC_MAX_TRY)
470 PRINTK2 ("%s: memory allocation, try %d succeeded ...\n",
473 /* I can send the packet now.. */
475 ioaddr = SMC_BASE_ADDRESS;
477 buf = (byte *) packet;
479 /* If I get here, I _know_ there is a packet slot waiting for me */
480 packet_no = SMC_inb (LAN91C96_ARR);
481 if (packet_no & LAN91C96_ARR_FAILED) {
482 /* or isn't there? BAD CHIP! */
483 printf ("%s: Memory allocation failed. \n", SMC_DEV_NAME);
487 /* we have a packet address, so tell the card to use it */
488 SMC_outb (packet_no, LAN91C96_PNR);
490 /* point to the beginning of the packet */
491 SMC_outw (LAN91C96_PTR_AUTO_INCR, LAN91C96_POINTER);
493 PRINTK3 ("%s: Trying to xmit packet of length %x\n",
494 SMC_DEV_NAME, length);
497 printf ("Transmitting Packet\n");
498 print_packet (buf, length);
501 /* send the packet length ( +6 for status, length and ctl byte )
502 and the status word ( set to zeros ) */
504 SMC_outl ((length + 6) << 16, LAN91C96_DATA_HIGH);
506 SMC_outw (0, LAN91C96_DATA_HIGH);
507 /* send the packet length ( +6 for status words, length, and ctl */
508 SMC_outw ((length + 6), LAN91C96_DATA_HIGH);
509 #endif /* USE_32_BIT */
511 /* send the actual data
512 * I _think_ it's faster to send the longs first, and then
513 * mop up by sending the last word. It depends heavily
514 * on alignment, at least on the 486. Maybe it would be
515 * a good idea to check which is optimal? But that could take
516 * almost as much time as is saved?
519 SMC_outsl (LAN91C96_DATA_HIGH, buf, length >> 2);
521 SMC_outw (*((word *) (buf + (length & 0xFFFFFFFC))),
524 SMC_outsw (LAN91C96_DATA_HIGH, buf, (length) >> 1);
525 #endif /* USE_32_BIT */
527 /* Send the last byte, if there is one. */
528 if ((length & 1) == 0) {
529 SMC_outw (0, LAN91C96_DATA_HIGH);
531 SMC_outw (buf[length - 1] | 0x2000, LAN91C96_DATA_HIGH);
534 /* and let the chipset deal with it */
535 SMC_outw (LAN91C96_MMUCR_ENQUEUE, LAN91C96_MMU);
537 /* poll for TX INT */
538 if (poll4int (LAN91C96_MSK_TX_INT, SMC_TX_TIMEOUT)) {
540 PRINTK2 ("%s: TX timeout, sending failed...\n", SMC_DEV_NAME);
543 SMC_outw (LAN91C96_MMUCR_RELEASE_TX, LAN91C96_MMU);
545 /* wait for MMU getting ready (low) */
546 while (SMC_inw (LAN91C96_MMU) & LAN91C96_MMUCR_NO_BUSY) {
550 PRINTK2 ("MMU ready\n");
556 SMC_outw (LAN91C96_IST_TX_INT, LAN91C96_INT_STATS);
558 PRINTK2 ("%s: Sent packet of length %d \n", SMC_DEV_NAME, length);
561 SMC_outw (LAN91C96_MMUCR_RELEASE_TX, LAN91C96_MMU);
563 /* wait for MMU getting ready (low) */
564 while (SMC_inw (LAN91C96_MMU) & LAN91C96_MMUCR_NO_BUSY) {
568 PRINTK2 ("MMU ready\n");
574 /*-------------------------------------------------------------------------
575 * smc_destructor( struct net_device * dev )
577 * dev, pointer to the device structure
581 *--------------------------------------------------------------------------
583 void smc_destructor ()
585 PRINTK2 (CARDNAME ":smc_destructor\n");
590 * Open and Initialize the board
592 * Set up everything, reset the card, etc ..
595 static int smc_open (bd_t *bd)
597 int i, err; /* used to set hw ethernet address */
599 PRINTK2 ("%s:smc_open\n", SMC_DEV_NAME);
601 /* reset the hardware */
608 err = smc_get_ethaddr (bd); /* set smc_mac_addr, and sync it with u-boot globals */
612 for (i = 0; i < 6; i += 2) {
615 address = smc_mac_addr[i + 1] << 8;
616 address |= smc_mac_addr[i];
617 SMC_outw (address, LAN91C96_IA0 + i);
620 for (i = 0; i < 6; i++)
621 SMC_outb (smc_mac_addr[i], LAN91C96_IA0 + i);
626 /*-------------------------------------------------------------
628 * smc_rcv - receive a packet from the card
630 * There is ( at least ) a packet waiting to be read from
634 * o If an error, record it
635 * o otherwise, read in the packet
636 *-------------------------------------------------------------
638 static int smc_rcv ()
651 packet_number = SMC_inw (LAN91C96_FIFO);
653 if (packet_number & LAN91C96_FIFO_RXEMPTY) {
657 PRINTK3 ("%s:smc_rcv\n", SMC_DEV_NAME);
658 /* start reading from the start of the packet */
659 SMC_outw (LAN91C96_PTR_READ | LAN91C96_PTR_RCV |
660 LAN91C96_PTR_AUTO_INCR, LAN91C96_POINTER);
662 /* First two words are status and packet_length */
664 stat_len = SMC_inl (LAN91C96_DATA_HIGH);
665 status = stat_len & 0xffff;
666 packet_length = stat_len >> 16;
668 status = SMC_inw (LAN91C96_DATA_HIGH);
669 packet_length = SMC_inw (LAN91C96_DATA_HIGH);
672 packet_length &= 0x07ff; /* mask off top bits */
674 PRINTK2 ("RCV: STATUS %4x LENGTH %4x\n", status, packet_length);
676 if (!(status & FRAME_FILTER)) {
677 /* Adjust for having already read the first two words */
678 packet_length -= 4; /*4; */
681 /* set odd length for bug in LAN91C111, */
682 /* which never sets RS_ODDFRAME */
687 PRINTK3 (" Reading %d dwords (and %d bytes) \n",
688 packet_length >> 2, packet_length & 3);
689 /* QUESTION: Like in the TX routine, do I want
690 to send the DWORDs or the bytes first, or some
691 mixture. A mixture might improve already slow PIO
693 SMC_insl (LAN91C96_DATA_HIGH, NetRxPackets[0], packet_length >> 2);
694 /* read the left over bytes */
695 if (packet_length & 3) {
698 byte *tail = (byte *) (NetRxPackets[0] + (packet_length & ~3));
699 dword leftover = SMC_inl (LAN91C96_DATA_HIGH);
701 for (i = 0; i < (packet_length & 3); i++)
702 *tail++ = (byte) (leftover >> (8 * i)) & 0xff;
705 PRINTK3 (" Reading %d words and %d byte(s) \n",
706 (packet_length >> 1), packet_length & 1);
707 SMC_insw (LAN91C96_DATA_HIGH, NetRxPackets[0], packet_length >> 1);
709 #endif /* USE_32_BIT */
712 printf ("Receiving Packet\n");
713 print_packet (NetRxPackets[0], packet_length);
721 while (SMC_inw (LAN91C96_MMU) & LAN91C96_MMUCR_NO_BUSY)
722 udelay (1); /* Wait until not busy */
724 /* error or good, tell the card to get rid of this packet */
725 SMC_outw (LAN91C96_MMUCR_RELEASE_RX, LAN91C96_MMU);
727 while (SMC_inw (LAN91C96_MMU) & LAN91C96_MMUCR_NO_BUSY)
728 udelay (1); /* Wait until not busy */
731 /* Pass the packet up to the protocol layers. */
732 NetReceive (NetRxPackets[0], packet_length);
733 return packet_length;
740 /*----------------------------------------------------
743 * this makes the board clean up everything that it can
744 * and not talk to the outside world. Caused by
745 * an 'ifconfig ethX down'
747 -----------------------------------------------------*/
748 static int smc_close ()
750 PRINTK2 ("%s:smc_close\n", SMC_DEV_NAME);
752 /* clear everything */
759 static void print_packet (byte * buf, int length)
766 printf ("Packet of length %d \n", length);
769 remainder = length % 16;
771 for (i = 0; i < lines; i++) {
774 for (cur = 0; cur < 8; cur++) {
779 printf ("%02x%02x ", a, b);
783 for (i = 0; i < remainder / 2; i++) {
788 printf ("%02x%02x ", a, b);
793 #endif /* SMC_DEBUG > 2 */
795 int eth_init (bd_t * bd)
797 return (smc_open(bd));
810 int eth_send (volatile void *packet, int length)
812 return smc_send_packet (packet, length);
817 /*-------------------------------------------------------------------------
821 * Reset and enable the device, check if the I/O space location
830 *--------------------------------------------------------------------------
832 static int smc_hw_init ()
834 unsigned short status_test;
836 /* The attribute register of the LAN91C96 is located at address
837 0x0e000000 on the lubbock platform */
838 volatile unsigned *attaddr = (unsigned *) (0x0e000000);
840 /* first reset, then enable the device. Sequence is critical */
841 attaddr[LAN91C96_ECOR] |= LAN91C96_ECOR_SRESET;
843 attaddr[LAN91C96_ECOR] &= ~LAN91C96_ECOR_SRESET;
844 attaddr[LAN91C96_ECOR] |= LAN91C96_ECOR_ENABLE;
846 /* force 16-bit mode */
847 attaddr[LAN91C96_ECSR] &= ~LAN91C96_ECSR_IOIS8;
850 /* check if the I/O address is correct, the upper byte of the
851 bank select register should read 0x33 */
853 status_test = SMC_inw (LAN91C96_BANK_SELECT);
854 if ((status_test & 0xFF00) != 0x3300) {
855 printf ("Failed to initialize ethernetchip\n");
862 /* smc_get_ethaddr (bd_t * bd)
864 * This checks both the environment and the ROM for an ethernet address. If
865 * found, the environment takes precedence.
868 int smc_get_ethaddr (bd_t * bd)
872 if (!eth_getenv_enetaddr("ethaddr", v_mac)) {
873 /* get ROM mac value if any */
874 if (!get_rom_mac(v_mac)) {
875 printf("\n*** ERROR: ethaddr is NOT set !!\n");
878 eth_setenv_enetaddr("ethaddr", v_mac);
881 smc_set_mac_addr(v_mac); /* use old function to update smc default */
882 PRINTK("Using MAC Address %pM\n", v_mac);
888 * Note, this has omly been tested for the OMAP730 P2.
891 int get_rom_mac (unsigned char *v_rom_mac)
893 #ifdef HARDCODE_MAC /* used for testing or to supress run time warnings */
894 char hw_mac_addr[] = { 0x02, 0x80, 0xad, 0x20, 0x31, 0xb8 };
896 memcpy (v_rom_mac, hw_mac_addr, 6);
903 v_rom_mac[i] = SMC_inb (LAN91C96_IA0 + i);