1/* 2 lne390.c 3 4 Linux driver for Mylex LNE390 EISA Network Adapter 5 6 Copyright (C) 1996-1998, Paul Gortmaker. 7 8 This software may be used and distributed according to the terms 9 of the GNU General Public License, incorporated herein by reference. 10 11 Information and Code Sources: 12 13 1) Based upon framework of es3210 driver. 14 2) The existing myriad of other Linux 8390 drivers by Donald Becker. 15 3) Russ Nelson's asm packet driver provided additional info. 16 4) Info for getting IRQ and sh-mem gleaned from the EISA cfg files. 17 18 The LNE390 is an EISA shared memory NS8390 implementation. Note 19 that all memory copies to/from the board must be 32bit transfers. 20 There are two versions of the card: the lne390a and the lne390b. 21 Going by the EISA cfg files, the "a" has jumpers to select between 22 BNC/AUI, but the "b" also has RJ-45 and selection is via the SCU. 23 The shared memory address selection is also slightly different. 24 Note that shared memory address > 1MB are supported with this driver. 25 26 You can try <http://www.mylex.com> if you want more info, as I've 27 never even seen one of these cards. :) 28 29 Arnaldo Carvalho de Melo <acme@conectiva.com.br> - 2000/09/01 30 - get rid of check_region 31 - no need to check if dev == NULL in lne390_probe1 32*/ 33 34static const char *version = 35 "lne390.c: Driver revision v0.99.1, 01/09/2000\n"; 36 37#include <linux/module.h> 38#include <linux/eisa.h> 39#include <linux/kernel.h> 40#include <linux/errno.h> 41#include <linux/string.h> 42#include <linux/delay.h> 43#include <linux/init.h> 44#include <linux/netdevice.h> 45#include <linux/etherdevice.h> 46 47#include <asm/io.h> 48#include <asm/system.h> 49 50#include "8390.h" 51 52#define DRV_NAME "lne390" 53 54static int lne390_probe1(struct net_device *dev, int ioaddr); 55 56static int lne390_open(struct net_device *dev); 57static int lne390_close(struct net_device *dev); 58 59static void lne390_reset_8390(struct net_device *dev); 60 61static void lne390_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page); 62static void lne390_block_input(struct net_device *dev, int count, struct sk_buff *skb, int ring_offset); 63static void lne390_block_output(struct net_device *dev, int count, const unsigned char *buf, const int start_page); 64 65#define LNE390_START_PG 0x00 /* First page of TX buffer */ 66#define LNE390_STOP_PG 0x80 /* Last page +1 of RX ring */ 67 68#define LNE390_ID_PORT 0xc80 /* Same for all EISA cards */ 69#define LNE390_IO_EXTENT 0x20 70#define LNE390_SA_PROM 0x16 /* Start of e'net addr. */ 71#define LNE390_RESET_PORT 0xc84 /* From the pkt driver source */ 72#define LNE390_NIC_OFFSET 0x00 /* Hello, the 8390 is *here* */ 73 74#define LNE390_ADDR0 0x00 /* 3 byte vendor prefix */ 75#define LNE390_ADDR1 0x80 76#define LNE390_ADDR2 0xe5 77 78#define LNE390_ID0 0x10009835 /* 0x3598 = 01101 01100 11000 = mlx */ 79#define LNE390_ID1 0x11009835 /* above is the 390A, this is 390B */ 80 81#define LNE390_CFG1 0xc84 /* NB: 0xc84 is also "reset" port. */ 82#define LNE390_CFG2 0xc90 83 84/* 85 * You can OR any of the following bits together and assign it 86 * to LNE390_DEBUG to get verbose driver info during operation. 87 * Currently only the probe one is implemented. 88 */ 89 90#define LNE390_D_PROBE 0x01 91#define LNE390_D_RX_PKT 0x02 92#define LNE390_D_TX_PKT 0x04 93#define LNE390_D_IRQ 0x08 94 95#define LNE390_DEBUG 0 96 97static unsigned char irq_map[] __initdata = {15, 12, 11, 10, 9, 7, 5, 3}; 98static unsigned int shmem_mapA[] __initdata = {0xff, 0xfe, 0xfd, 0xfff, 0xffe, 0xffc, 0x0d, 0x0}; 99static unsigned int shmem_mapB[] __initdata = {0xff, 0xfe, 0x0e, 0xfff, 0xffe, 0xffc, 0x0d, 0x0}; 100 101/* 102 * Probe for the card. The best way is to read the EISA ID if it 103 * is known. Then we can check the prefix of the station address 104 * PROM for a match against the value assigned to Mylex. 105 */ 106 107static int __init do_lne390_probe(struct net_device *dev) 108{ 109 unsigned short ioaddr = dev->base_addr; 110 int irq = dev->irq; 111 int mem_start = dev->mem_start; 112 int ret; 113 114 SET_MODULE_OWNER(dev); 115 116 if (ioaddr > 0x1ff) { /* Check a single specified location. */ 117 if (!request_region(ioaddr, LNE390_IO_EXTENT, DRV_NAME)) 118 return -EBUSY; 119 ret = lne390_probe1(dev, ioaddr); 120 if (ret) 121 release_region(ioaddr, LNE390_IO_EXTENT); 122 return ret; 123 } 124 else if (ioaddr > 0) /* Don't probe at all. */ 125 return -ENXIO; 126 127 if (!EISA_bus) { 128#if LNE390_DEBUG & LNE390_D_PROBE 129 printk("lne390-debug: Not an EISA bus. Not probing high ports.\n"); 130#endif 131 return -ENXIO; 132 } 133 134 /* EISA spec allows for up to 16 slots, but 8 is typical. */ 135 for (ioaddr = 0x1000; ioaddr < 0x9000; ioaddr += 0x1000) { 136 if (!request_region(ioaddr, LNE390_IO_EXTENT, DRV_NAME)) 137 continue; 138 if (lne390_probe1(dev, ioaddr) == 0) 139 return 0; 140 release_region(ioaddr, LNE390_IO_EXTENT); 141 dev->irq = irq; 142 dev->mem_start = mem_start; 143 } 144 145 return -ENODEV; 146} 147 148#ifndef MODULE 149struct net_device * __init lne390_probe(int unit) 150{ 151 struct net_device *dev = alloc_ei_netdev(); 152 int err; 153 154 if (!dev) 155 return ERR_PTR(-ENOMEM); 156 157 sprintf(dev->name, "eth%d", unit); 158 netdev_boot_setup_check(dev); 159 160 err = do_lne390_probe(dev); 161 if (err) 162 goto out; 163 return dev; 164out: 165 free_netdev(dev); 166 return ERR_PTR(err); 167} 168#endif 169 170static int __init lne390_probe1(struct net_device *dev, int ioaddr) 171{ 172 int i, revision, ret; 173 unsigned long eisa_id; 174 175 if (inb_p(ioaddr + LNE390_ID_PORT) == 0xff) return -ENODEV; 176 177#if LNE390_DEBUG & LNE390_D_PROBE 178 printk("lne390-debug: probe at %#x, ID %#8x\n", ioaddr, inl(ioaddr + LNE390_ID_PORT)); 179 printk("lne390-debug: config regs: %#x %#x\n", 180 inb(ioaddr + LNE390_CFG1), inb(ioaddr + LNE390_CFG2)); 181#endif 182 183 184/* Check the EISA ID of the card. */ 185 eisa_id = inl(ioaddr + LNE390_ID_PORT); 186 if ((eisa_id != LNE390_ID0) && (eisa_id != LNE390_ID1)) { 187 return -ENODEV; 188 } 189 190 revision = (eisa_id >> 24) & 0x01; /* 0 = rev A, 1 rev B */ 191 192 193 printk("lne390.c: LNE390%X in EISA slot %d, address", 0xa+revision, ioaddr/0x1000); 194 for(i = 0; i < ETHER_ADDR_LEN; i++) 195 printk(" %02x", (dev->dev_addr[i] = inb(ioaddr + LNE390_SA_PROM + i))); 196 printk(".\nlne390.c: "); 197 198 /* Snarf the interrupt now. CFG file has them all listed as `edge' with share=NO */ 199 if (dev->irq == 0) { 200 unsigned char irq_reg = inb(ioaddr + LNE390_CFG2) >> 3; 201 dev->irq = irq_map[irq_reg & 0x07]; 202 printk("using"); 203 } else { 204 /* This is useless unless we reprogram the card here too */ 205 if (dev->irq == 2) dev->irq = 9; /* Doh! */ 206 printk("assigning"); 207 } 208 printk(" IRQ %d,", dev->irq); 209 210 if ((ret = request_irq(dev->irq, ei_interrupt, 0, DRV_NAME, dev))) { 211 printk (" unable to get IRQ %d.\n", dev->irq); 212 return ret; 213 } 214 215 if (dev->mem_start == 0) { 216 unsigned char mem_reg = inb(ioaddr + LNE390_CFG2) & 0x07; 217 218 if (revision) /* LNE390B */ 219 dev->mem_start = shmem_mapB[mem_reg] * 0x10000; 220 else /* LNE390A */ 221 dev->mem_start = shmem_mapA[mem_reg] * 0x10000; 222 printk(" using "); 223 } else { 224 /* Should check for value in shmem_map and reprogram the card to use it */ 225 dev->mem_start &= 0xfff0000; 226 printk(" assigning "); 227 } 228 229 printk("%dkB memory at physical address %#lx\n", 230 LNE390_STOP_PG/4, dev->mem_start); 231 232 /* 233 BEWARE!! Some dain-bramaged EISA SCUs will allow you to put 234 the card mem within the region covered by `normal' RAM !!! 235 236 ioremap() will fail in that case. 237 */ 238 ei_status.mem = ioremap(dev->mem_start, LNE390_STOP_PG*0x100); 239 if (!ei_status.mem) { 240 printk(KERN_ERR "lne390.c: Unable to remap card memory above 1MB !!\n"); 241 printk(KERN_ERR "lne390.c: Try using EISA SCU to set memory below 1MB.\n"); 242 printk(KERN_ERR "lne390.c: Driver NOT installed.\n"); 243 ret = -EAGAIN; 244 goto cleanup; 245 } 246 printk("lne390.c: remapped %dkB card memory to virtual address %p\n", 247 LNE390_STOP_PG/4, ei_status.mem); 248 249 dev->mem_start = (unsigned long)ei_status.mem; 250 dev->mem_end = dev->mem_start + (LNE390_STOP_PG - LNE390_START_PG)*256; 251 252 /* The 8390 offset is zero for the LNE390 */ 253 dev->base_addr = ioaddr; 254 255 ei_status.name = "LNE390"; 256 ei_status.tx_start_page = LNE390_START_PG; 257 ei_status.rx_start_page = LNE390_START_PG + TX_PAGES; 258 ei_status.stop_page = LNE390_STOP_PG; 259 ei_status.word16 = 1; 260 261 if (ei_debug > 0) 262 printk(version); 263 264 ei_status.reset_8390 = &lne390_reset_8390; 265 ei_status.block_input = &lne390_block_input; 266 ei_status.block_output = &lne390_block_output; 267 ei_status.get_8390_hdr = &lne390_get_8390_hdr; 268 269 dev->open = &lne390_open; 270 dev->stop = &lne390_close; 271#ifdef CONFIG_NET_POLL_CONTROLLER 272 dev->poll_controller = ei_poll; 273#endif 274 NS8390_init(dev, 0); 275 276 ret = register_netdev(dev); 277 if (ret) 278 goto unmap; 279 return 0; 280unmap: 281 if (ei_status.reg0) 282 iounmap(ei_status.mem); 283cleanup: 284 free_irq(dev->irq, dev); 285 return ret; 286} 287 288/* 289 * Reset as per the packet driver method. Judging by the EISA cfg 290 * file, this just toggles the "Board Enable" bits (bit 2 and 0). 291 */ 292 293static void lne390_reset_8390(struct net_device *dev) 294{ 295 unsigned short ioaddr = dev->base_addr; 296 297 outb(0x04, ioaddr + LNE390_RESET_PORT); 298 if (ei_debug > 1) printk("%s: resetting the LNE390...", dev->name); 299 300 mdelay(2); 301 302 ei_status.txing = 0; 303 outb(0x01, ioaddr + LNE390_RESET_PORT); 304 if (ei_debug > 1) printk("reset done\n"); 305 306 return; 307} 308 309/* 310 * Note: In the following three functions is the implicit assumption 311 * that the associated memcpy will only use "rep; movsl" as long as 312 * we keep the counts as some multiple of doublewords. This is a 313 * requirement of the hardware, and also prevents us from using 314 * eth_io_copy_and_sum() since we can't guarantee it will limit 315 * itself to doubleword access. 316 */ 317 318/* 319 * Grab the 8390 specific header. Similar to the block_input routine, but 320 * we don't need to be concerned with ring wrap as the header will be at 321 * the start of a page, so we optimize accordingly. (A single doubleword.) 322 */ 323 324static void 325lne390_get_8390_hdr(struct net_device *dev, struct e8390_pkt_hdr *hdr, int ring_page) 326{ 327 void __iomem *hdr_start = ei_status.mem + ((ring_page - LNE390_START_PG)<<8); 328 memcpy_fromio(hdr, hdr_start, sizeof(struct e8390_pkt_hdr)); 329 hdr->count = (hdr->count + 3) & ~3; /* Round up allocation. */ 330} 331 332/* 333 * Block input and output are easy on shared memory ethercards, the only 334 * complication is when the ring buffer wraps. The count will already 335 * be rounded up to a doubleword value via lne390_get_8390_hdr() above. 336 */ 337 338static void lne390_block_input(struct net_device *dev, int count, struct sk_buff *skb, 339 int ring_offset) 340{ 341 void __iomem *xfer_start = ei_status.mem + ring_offset - (LNE390_START_PG<<8); 342 343 if (ring_offset + count > (LNE390_STOP_PG<<8)) { 344 /* Packet wraps over end of ring buffer. */ 345 int semi_count = (LNE390_STOP_PG<<8) - ring_offset; 346 memcpy_fromio(skb->data, xfer_start, semi_count); 347 count -= semi_count; 348 memcpy_fromio(skb->data + semi_count, 349 ei_status.mem + (TX_PAGES<<8), count); 350 } else { 351 /* Packet is in one chunk. */ 352 memcpy_fromio(skb->data, xfer_start, count); 353 } 354} 355 356static void lne390_block_output(struct net_device *dev, int count, 357 const unsigned char *buf, int start_page) 358{ 359 void __iomem *shmem = ei_status.mem + ((start_page - LNE390_START_PG)<<8); 360 361 count = (count + 3) & ~3; /* Round up to doubleword */ 362 memcpy_toio(shmem, buf, count); 363} 364 365static int lne390_open(struct net_device *dev) 366{ 367 ei_open(dev); 368 return 0; 369} 370 371static int lne390_close(struct net_device *dev) 372{ 373 374 if (ei_debug > 1) 375 printk("%s: Shutting down ethercard.\n", dev->name); 376 377 ei_close(dev); 378 return 0; 379} 380 381#ifdef MODULE 382#define MAX_LNE_CARDS 4 /* Max number of LNE390 cards per module */ 383static struct net_device *dev_lne[MAX_LNE_CARDS]; 384static int io[MAX_LNE_CARDS]; 385static int irq[MAX_LNE_CARDS]; 386static int mem[MAX_LNE_CARDS]; 387 388module_param_array(io, int, NULL, 0); 389module_param_array(irq, int, NULL, 0); 390module_param_array(mem, int, NULL, 0); 391MODULE_PARM_DESC(io, "I/O base address(es)"); 392MODULE_PARM_DESC(irq, "IRQ number(s)"); 393MODULE_PARM_DESC(mem, "memory base address(es)"); 394MODULE_DESCRIPTION("Mylex LNE390A/B EISA Ethernet driver"); 395MODULE_LICENSE("GPL"); 396 397int __init init_module(void) 398{ 399 struct net_device *dev; 400 int this_dev, found = 0; 401 402 for (this_dev = 0; this_dev < MAX_LNE_CARDS; this_dev++) { 403 if (io[this_dev] == 0 && this_dev != 0) 404 break; 405 dev = alloc_ei_netdev(); 406 if (!dev) 407 break; 408 dev->irq = irq[this_dev]; 409 dev->base_addr = io[this_dev]; 410 dev->mem_start = mem[this_dev]; 411 if (do_lne390_probe(dev) == 0) { 412 dev_lne[found++] = dev; 413 continue; 414 } 415 free_netdev(dev); 416 printk(KERN_WARNING "lne390.c: No LNE390 card found (i/o = 0x%x).\n", io[this_dev]); 417 break; 418 } 419 if (found) 420 return 0; 421 return -ENXIO; 422} 423 424static void cleanup_card(struct net_device *dev) 425{ 426 free_irq(dev->irq, dev); 427 release_region(dev->base_addr, LNE390_IO_EXTENT); 428 iounmap(ei_status.mem); 429} 430 431void __exit cleanup_module(void) 432{ 433 int this_dev; 434 435 for (this_dev = 0; this_dev < MAX_LNE_CARDS; this_dev++) { 436 struct net_device *dev = dev_lne[this_dev]; 437 if (dev) { 438 unregister_netdev(dev); 439 cleanup_card(dev); 440 free_netdev(dev); 441 } 442 } 443} 444#endif /* MODULE */ 445