/Documentation/networking/sis900.txt

https://bitbucket.org/evzijst/gittest · Plain Text · 257 lines · 187 code · 70 blank · 0 comment · 0 complexity · f9f74291fc6e2e66542d68a07473af39 MD5 · raw file

  1. SiS 900/7016 Fast Ethernet Device Driver
  2. Ollie Lho
  3. Lei Chun Chang
  4. Copyright © 1999 by Silicon Integrated System Corp.
  5. This document gives some information on installation and usage of SiS
  6. 900/7016 device driver under Linux.
  7. This program is free software; you can redistribute it and/or modify
  8. it under the terms of the GNU General Public License as published by
  9. the Free Software Foundation; either version 2 of the License, or (at
  10. your option) any later version.
  11. This program is distributed in the hope that it will be useful, but
  12. WITHOUT ANY WARRANTY; without even the implied warranty of
  13. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14. General Public License for more details.
  15. You should have received a copy of the GNU General Public License
  16. along with this program; if not, write to the Free Software
  17. Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  18. USA
  19. _________________________________________________________________
  20. Table of Contents
  21. 1. Introduction
  22. 2. Changes
  23. 3. Tested Environment
  24. 4. Files in This Package
  25. 5. Installation
  26. Building the driver as loadable module
  27. Building the driver into kernel
  28. 6. Known Problems and Bugs
  29. 7. Revision History
  30. 8. Acknowledgements
  31. _________________________________________________________________
  32. Chapter 1. Introduction
  33. This document describes the revision 1.06 and 1.07 of SiS 900/7016
  34. Fast Ethernet device driver under Linux. The driver is developed by
  35. Silicon Integrated System Corp. and distributed freely under the GNU
  36. General Public License (GPL). The driver can be compiled as a loadable
  37. module and used under Linux kernel version 2.2.x. (rev. 1.06) With
  38. minimal changes, the driver can also be used under 2.3.x and 2.4.x
  39. kernel (rev. 1.07), please see Chapter 5. If you are intended to use
  40. the driver for earlier kernels, you are on your own.
  41. The driver is tested with usual TCP/IP applications including FTP,
  42. Telnet, Netscape etc. and is used constantly by the developers.
  43. Please send all comments/fixes/questions to Lei-Chun Chang.
  44. _________________________________________________________________
  45. Chapter 2. Changes
  46. Changes made in Revision 1.07
  47. 1. Separation of sis900.c and sis900.h in order to move most constant
  48. definition to sis900.h (many of those constants were corrected)
  49. 2. Clean up PCI detection, the pci-scan from Donald Becker were not
  50. used, just simple pci_find_*.
  51. 3. MII detection is modified to support multiple mii transceiver.
  52. 4. Bugs in read_eeprom, mdio_* were removed.
  53. 5. Lot of sis900 irrelevant comments were removed/changed and more
  54. comments were added to reflect the real situation.
  55. 6. Clean up of physical/virtual address space mess in buffer
  56. descriptors.
  57. 7. Better transmit/receive error handling.
  58. 8. The driver now uses zero-copy single buffer management scheme to
  59. improve performance.
  60. 9. Names of variables were changed to be more consistent.
  61. 10. Clean up of auo-negotiation and timer code.
  62. 11. Automatic detection and change of PHY on the fly.
  63. 12. Bug in mac probing fixed.
  64. 13. Fix 630E equalier problem by modifying the equalizer workaround
  65. rule.
  66. 14. Support for ICS1893 10/100 Interated PHYceiver.
  67. 15. Support for media select by ifconfig.
  68. 16. Added kernel-doc extratable documentation.
  69. _________________________________________________________________
  70. Chapter 3. Tested Environment
  71. This driver is developed on the following hardware
  72. * Intel Celeron 500 with SiS 630 (rev 02) chipset
  73. * SiS 900 (rev 01) and SiS 7016/7014 Fast Ethernet Card
  74. and tested with these software environments
  75. * Red Hat Linux version 6.2
  76. * Linux kernel version 2.4.0
  77. * Netscape version 4.6
  78. * NcFTP 3.0.0 beta 18
  79. * Samba version 2.0.3
  80. _________________________________________________________________
  81. Chapter 4. Files in This Package
  82. In the package you can find these files:
  83. sis900.c
  84. Driver source file in C
  85. sis900.h
  86. Header file for sis900.c
  87. sis900.sgml
  88. DocBook SGML source of the document
  89. sis900.txt
  90. Driver document in plain text
  91. _________________________________________________________________
  92. Chapter 5. Installation
  93. Silicon Integrated System Corp. is cooperating closely with core Linux
  94. Kernel developers. The revisions of SiS 900 driver are distributed by
  95. the usuall channels for kernel tar files and patches. Those kernel tar
  96. files for official kernel and patches for kernel pre-release can be
  97. download at official kernel ftp site and its mirrors. The 1.06
  98. revision can be found in kernel version later than 2.3.15 and
  99. pre-2.2.14, and 1.07 revision can be found in kernel version 2.4.0. If
  100. you have no prior experience in networking under Linux, please read
  101. Ethernet HOWTO and Networking HOWTO available from Linux Documentation
  102. Project (LDP).
  103. The driver is bundled in release later than 2.2.11 and 2.3.15 so this
  104. is the most easy case. Be sure you have the appropriate packages for
  105. compiling kernel source. Those packages are listed in Document/Changes
  106. in kernel source distribution. If you have to install the driver other
  107. than those bundled in kernel release, you should have your driver file
  108. sis900.c and sis900.h copied into /usr/src/linux/drivers/net/ first.
  109. There are two alternative ways to install the driver
  110. _________________________________________________________________
  111. Building the driver as loadable module
  112. To build the driver as a loadable kernel module you have to
  113. reconfigure the kernel to activate network support by
  114. make menuconfig
  115. Choose "Loadable module support --->", then select "Enable loadable
  116. module support".
  117. Choose "Network Device Support --->", select "Ethernet (10 or
  118. 100Mbit)". Then select "EISA, VLB, PCI and on board controllers", and
  119. choose "SiS 900/7016 PCI Fast Ethernet Adapter support" to "M".
  120. After reconfiguring the kernel, you can make the driver module by
  121. make modules
  122. The driver should be compiled with no errors. After compiling the
  123. driver, the driver can be installed to proper place by
  124. make modules_install
  125. Load the driver into kernel by
  126. insmod sis900
  127. When loading the driver into memory, some information message can be
  128. view by
  129. dmesg
  130. or
  131. cat /var/log/message
  132. If the driver is loaded properly you will have messages similar to
  133. this:
  134. sis900.c: v1.07.06 11/07/2000
  135. eth0: SiS 900 PCI Fast Ethernet at 0xd000, IRQ 10, 00:00:e8:83:7f:a4.
  136. eth0: SiS 900 Internal MII PHY transceiver found at address 1.
  137. eth0: Using SiS 900 Internal MII PHY as default
  138. showing the version of the driver and the results of probing routine.
  139. Once the driver is loaded, network can be brought up by
  140. /sbin/ifconfig eth0 IPADDR broadcast BROADCAST netmask NETMASK media TYPE
  141. where IPADDR, BROADCAST, NETMASK are your IP address, broadcast
  142. address and netmask respectively. TYPE is used to set medium type used
  143. by the device. Typical values are "10baseT"(twisted-pair 10Mbps
  144. Ethernet) or "100baseT" (twisted-pair 100Mbps Ethernet). For more
  145. information on how to configure network interface, please refer to
  146. Networking HOWTO.
  147. The link status is also shown by kernel messages. For example, after
  148. the network interface is activated, you may have the message:
  149. eth0: Media Link On 100mbps full-duplex
  150. If you try to unplug the twist pair (TP) cable you will get
  151. eth0: Media Link Off
  152. indicating that the link is failed.
  153. _________________________________________________________________
  154. Building the driver into kernel
  155. If you want to make the driver into kernel, choose "Y" rather than "M"
  156. on "SiS 900/7016 PCI Fast Ethernet Adapter support" when configuring
  157. the kernel. Build the kernel image in the usual way
  158. make clean
  159. make bzlilo
  160. Next time the system reboot, you have the driver in memory.
  161. _________________________________________________________________
  162. Chapter 6. Known Problems and Bugs
  163. There are some known problems and bugs. If you find any other bugs
  164. please mail to lcchang@sis.com.tw
  165. 1. AM79C901 HomePNA PHY is not thoroughly tested, there may be some
  166. bugs in the "on the fly" change of transceiver.
  167. 2. A bug is hidden somewhere in the receive buffer management code,
  168. the bug causes NULL pointer reference in the kernel. This fault is
  169. caught before bad things happen and reported with the message:
  170. eth0: NULL pointer encountered in Rx ring, skipping which can be
  171. viewed with dmesg or cat /var/log/message.
  172. 3. The media type change from 10Mbps to 100Mbps twisted-pair ethernet
  173. by ifconfig causes the media link down.
  174. _________________________________________________________________
  175. Chapter 7. Revision History
  176. * November 13, 2000, Revision 1.07, seventh release, 630E problem
  177. fixed and further clean up.
  178. * November 4, 1999, Revision 1.06, Second release, lots of clean up
  179. and optimization.
  180. * August 8, 1999, Revision 1.05, Initial Public Release
  181. _________________________________________________________________
  182. Chapter 8. Acknowledgements
  183. This driver was originally derived form Donald Becker's pci-skeleton
  184. and rtl8139 drivers. Donald also provided various suggestion regarded
  185. with improvements made in revision 1.06.
  186. The 1.05 revision was created by Jim Huang, AMD 79c901 support was
  187. added by Chin-Shan Li.