i386/linux/linux-2.3.21/Documentation/networking/tlan.txt

   1 TLAN driver for Linux, version 1.0
   2 README
   3
   4 Well, I'm back.  The TLAN driver seems pretty stable, so I'm
   5 declaring this cycle of development finished, and calling the
   6 driver 1.0.  I will, of course continue to work on improving
   7 the driver, and work towards a 2.0 release.
   8
   9
  10 James
  11 james@sovereign.org
  12
  13
  14
  15 I.  Supported Devices.
  16
  17     Only PCI devices will work with this driver.
  18
  19     Supported:
  20     Vendor ID   Device ID       Name
  21     0e11        ae32            Compaq Netelligent 10/100 TX PCI UTP
  22     0e11        ae34            Compaq Netelligent 10 T PCI UTP
  23     0e11        ae35            Compaq Integrated NetFlex 3/P
  24     0e11        ae40            Compaq Netelligent Dual 10/100 TX PCI UTP
  25     0e11        ae43            Compaq Netelligent Integrated 10/100 TX UTP
  26     0e11        b011            Compaq Netelligent 10/100 TX Embedded UTP
  27     0e11        b012            Compaq Netelligent 10 T/2 PCI UTP/Coax
  28     0e11        b030            Compaq Netelligent 10/100 TX UTP
  29     0e11        f130            Compaq NetFlex 3/P
  30     0e11        f150            Compaq NetFlex 3/P
  31     108d        0012            Olicom OC-2325
  32     108d        0013            Olicom OC-2183
  33     108d        0014            Olicom OC-2326
  34
  35
  36     Caveats:
  37
  38     I am not sure if 100BaseTX daughterboards (for those cards which
  39     support such things) will work.  I haven't had any solid evidence
  40     either way.
  41
  42     However, if a card supports 100BaseTx without requiring an add
  43     on daughterboard, it should work with 100BaseTx.
  44
  45     The "Netelligent 10 T/2 PCI UTP/Coax" (b012) device is untested,
  46     but I do not expect any problems.
  47
  48
  49 II.  Building the Driver.
  50
  51     The TLAN driver may be compiled into the kernel, or it may be compiled
  52     as a module separately, or in the kernel.  A patch is included for
  53     2.0.29 (which also works for 2.0.30, 2.0.31, and 2.0.32).
  54
  55     To compile it as part of the kernel:
  56         1. Download and untar the TLAN driver package.
  57         2. If your kernel is 2.1.45 or later, you do not need to patch the
  58            kernel sources.  Copy the tlan.c and tlan.h to drivers/net in
  59            the kernel source tree.
  60         3. Otherwise, apply the appropriate patch for your kernel.  For
  61            example:
  62
  63                cd /usr/src/linux
  64                patch -p1 < kernel.2.0.29
  65
  66         4. Copy the files tlan.c and tlan.h from the TLAN package to the
  67            directory drivers/net in the Linux kernel source tree.
  68         5. Configure your kernel for the TLAN driver.  Answer 'Y' when
  69            prompted to ask about experimental code (the first question).
  70            Then answer 'Y' when prompted if to include TI ThunderLAN
  71            support.  If you want the driver compiled as a module, answer 'M'
  72            instead of 'Y'.
  73         6. Make the kernel and, if necessary, the modules.
  74
  75     To compile the TLAN driver independently:
  76         1. Download and untar the TLAN driver package.
  77         2. Change to the tlan directory.
  78         3. If you are NOT using a versioned kernel (ie, want an non-
  79            versioned module), edit the Makefile, and comment out the
  80            line:
  81                  MODVERSIONS = -DMODVERSIONS
  82         4. Run 'make'.
  83
  84
  85 III.  Driver Options
  86         1. You can append debug=x to the end of the insmod line to get
  87            debug messages, where x is a bit field where the bits mean
  88            the following:
  89
  90            0x01         Turn on general debugging messages.
  91            0x02         Turn on receive debugging messages.
  92            0x04         Turn on transmit debugging messages.
  93            0x08         Turn on list debugging messsages.
  94
  95         2. You can append aui=1 to the end of the insmod line to cause
  96            the adapter to use the AUI interface instead of the 10 Base T
  97            interface.  This is also what to do if you want to use the BNC
  98            connector on a TLAN based device.  (Setting this option on a
  99            device that does not have an AUI/BNC connector will probably
 100            cause it to not function correctly.)
 101
 102         4. You can set duplex=1 to force half duplex, and duplex=2 to
 103            force full duplex.
 104
 105         5. You can set speed=10 to force 10Mbs operation, and speed=100Mbs
 106            to force 100Mbs operation. (I'm not sure what will happen
 107            if a card which only supports 10Mbs is forced into 100Mbs
 108            mode.)
 109
 110         3. If the driver is built into the kernel, you can use the 3rd
 111            and 4th parameters to set aui and debug respectively.  For
 112            example:
 113
 114            ether=0,0,0x1,0x7,eth0
 115
 116            This sets aui to 0x1 and debug to 0x7, assuming eth0 is a
 117            supported TLAN device.
 118
 119            The bits in the third byte are assigned as follows:
 120
 121                 0x01 = aui
 122                 0x02 = use SA_INTERRUPT flag when reserving the irq.
 123                 0x04 = use half duplex
 124                 0x08 = use full duplex
 125                 0x10 = use 10BaseT
 126                 0x20 = use 100BaseTx
 127
 128
 129 IV.  Things to try if you have problems.
 130         1. Make sure your card's PCI id is among those listed in
 131            section I, above.
 132         1. Make sure routing is correct.
 133         2. If you are using a 2.1.x kernel, try to duplicate the
 134            problem on a 2.0.x (preferably 2.0.29 or 2.0.30) kernel.
 135
 136
 137 There is also a tlan mailing list which you can join by sending "subscribe tlan"
 138 in the body of an email to majordomo@vuser.vu.union.edu.
 139
 140