Make dmfe documentation nicer
PATCH 1/1 Make dmfe documentation nicer
Hi,
I sent this patch to Rusty Russell's trivial patch monkey _months_ ago but its still not in mainline so here I send it again. So please apply it to mainline.
Here is what it changes :
- Indent it nicely
- Add a tip that CNET network cards use Davicom chipsets
- Add Maintainers/Contributors to the end of documentation like in other docs.
Regards,
ismail
Signature · 1 line
Time is what you make of it
dmfe2.txt renamed from dmfe.txt +44 -38
@@ -1,59 +1,65 @@ - dmfe.c: Version 1.28 01/18/2000 +Davicom DM9102(A)/DM9132/DM9801 fast ethernet driver for Linux. - A Davicom DM9102(A)/DM9132/DM9801 fast ethernet driver for Linux. - Copyright (C) 1997 Sten Wang +This program is free software; you can redistribute it and/or +modify it under the terms of the GNU General Public License +as published by the Free Software Foundation; either version 2 +of the License, or (at your option) any later version. - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. +This driver provides kernel support for Davicom DM9102(A)/DM9132/DM9801 ethernet cards ( CNET +10/100 ethernet cards uses Davicom chipset too, so this driver supports CNET cards too ).If you +didn't compile this driver as a module, it will automatically load itself on boot and print a +line similar to : - A. Compiler command: + dmfe: Davicom DM9xxx net driver, version 1.36.4 (2002-01-17) - A-1: For normal single or multiple processor kernel - "gcc -DMODULE -D__KERNEL__ -I/usr/src/linux/net/inet -Wall - -Wstrict-prototypes -O6 -c dmfe.c" +If you compiled this driver as a module, you have to load it on boot.You can load it with command : - A-2: For single or multiple processor with kernel module version function - "gcc -DMODULE -DMODVERSIONS -D__KERNEL__ -I/usr/src/linux/net/inet - -Wall -Wstrict-prototypes -O6 -c dmfe.c" + insmod dmfe +This way it will autodetect the device mode.This is the suggested way to load the module.Or you can pass +a mode= setting to module while loading, like : - B. The following steps teach you how to activate a DM9102 board: + insmod dmfe mode=0 # Force 10M Half Duplex + insmod dmfe mode=1 # Force 100M Half Duplex + insmod dmfe mode=4 # Force 10M Full Duplex + insmod dmfe mode=5 # Force 100M Full Duplex - 1. Used the upper compiler command to compile dmfe.c +Next you should configure your network interface with a command similar to : - 2. Insert dmfe module into kernel - "insmod dmfe" ;;Auto Detection Mode (Suggest) - "insmod dmfe mode=0" ;;Force 10M Half Duplex - "insmod dmfe mode=1" ;;Force 100M Half Duplex - "insmod dmfe mode=4" ;;Force 10M Full Duplex - "insmod dmfe mode=5" ;;Force 100M Full Duplex + ifconfig eth0 172.22.3.18 + ^^^^^^^^^^^ + Your IP Adress - 3. Config a dm9102 network interface - "ifconfig eth0 172.22.3.18" - ^^^^^^^^^^^ Your IP address +Then you may have to modify the default routing table with command : - 4. Activate the IP routing table. For some distributions, it is not - necessary. You can type "route" to check. + route add default eth0 - "route add default eth0" +Now your ethernet card should be up and running. - 5. Well done. Your DM9102 adapter is now activated. +TODO: - C. Object files description: - 1. dmfe_rh61.o: For Redhat 6.1 +Implement pci_driver::suspend() and pci_driver::resume() power management methods. +Check on 64 bit boxes. +Check and fix on big endian boxes. +Test and make sure PCI latency is now correct for all cases. - If you can make sure your kernel version, you can rename - to dmfe.o and directly use it without re-compiling. +Authors: - Author: Sten Wang, 886-3-5798797-8517, E-mail: [email protected] +Sten Wang <[email protected] > : Original Author +Tobias Ringstrom <[email protected]> : Current Maintainer + +Contributors: + +Marcelo Tosatti <[email protected]> +Alan Cox <[email protected]> +Jeff Garzik <[email protected]> +Vojtech Pavlik <[email protected]>
Quoted 10 lines · On Tue, 26 Apr 2005 09:56:36 +0300 ismail dönmez <[email protected]>…
Hi,
I sent this patch to Rusty Russell's trivial patch monkey _months_ ago but its still not in mainline so here I send it again. So please apply it to mainline.
Here is what it changes :- Indent it nicely
- Add a tip that CNET network cards use Davicom chipsets
- Add Maintainers/Contributors to the end of documentation like in other docs.
Please submit in proper format, including corrected file name level (begin at linux/drivers/net/tulip/....).
See Documentation/SubmittingPatches,
http://linux.yyz.us/patch-format.html , and
http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt
then send it to [email protected] and [email protected], please.
Alternatively, you can try kernel-janitors if Rusty is not responding... (see http://janitor.kernelnewbies.org/ )
Signature · 1 line
~Randy