SIS900 驱动程式解析

Sis900 驱动程序解析

作者 : wycc

SIS 900 是一个可以用来实作 10/100 网络卡的控制芯片。它提供了对 PCI mastermode , MII, 802.3x 流量控制等各种标准的支持。这篇文章将告诉大家，如何写一个 Linux 的网络驱动程序，它将比大家想象中简单很多。这篇文章将以 Linux 2.4 版为对象， 2.2 版提供的界面略有不同，但差别并不太大，读完本文后再读 2.2 版的程序码应该不会有太大困难才是。 本文所参考的驱动程序是在 2.4.3 版中 drivers/net/sis900.c 这个档案。你可以在 http://xxx.xxx.xxx.xxx/linux-2.4.3/drivers/net/sis900.c 找到它。

如果你能有一份硬件的 databook 在手边，读起驱动程序的码可能会更简单。 SIS900的 databook 可以直接在 http://www.sis.com.tw/ftp/Databook/900/sis900.exe下载。

PCI 驱动程序
对一个 PCI 驱动程序而言， Linux 提供了很完整的支持，大部份的 PCI 资讯都由内建的程序读出。对个别的驱动程序而言直接使用就可以了。所以在这个部份，唯一要做的事只是告知 PCI 子系统一个新的驱动程序己经被加入系统之中了。

在档案的最末端，你会看到下面的程序，

static struct pci_driver sis900_pci_driver = {         name:           SIS900_MODULE_NAME,         id_table:       sis900_pci_tbl,         probe:          sis900_probe,         remove:         sis900_remove, }; static int __init sis900_init_module(void) {         printk(KERN_INFO "%s", version);         return pci_module_init(&sis900_pci_driver); } static void __exit sis900_cleanup_module(void) {         pci_unregister_driver(&sis900_pci_driver); }

pci_module_init 是用来向 PCI 子系统注册一个 PCI 驱动程序。根据 id_table 中所提供的资料， PCI 子系统会在发现符合驱动程序要求的装置时使用它。那 PCI 子系统如何做到这件事呢 ? 我们先看一下 id_table 的内容就很清楚了。

static struct pci_device_id sis900_pci_tbl [] __devinitdata = {         {PCI_VENDOR_ID_SI, PCI_DEVICE_ID_SI_900,          PCI_ANY_ID, PCI_ANY_ID, 0, 0, SIS_900},         {PCI_VENDOR_ID_SI, PCI_DEVICE_ID_SI_7016,          PCI_ANY_ID, PCI_ANY_ID, 0, 0, SIS_7016},          }; MODULE_DEVICE_TABLE (pci, sis900_pci_tbl);

看懂了吗 ? 嗯，我想你懂了。不过我还是解释一下。前面四个分别是

1. • vendor id : PCI_VENDOR_ID_SI
   • device id : PCI_DEVICE_ID_SI_900
   • sub vendor id : PCI_ANY_ID
   • sub device id : PCI_ANY_ID

意思是说这个驱动程序支持 SIS 出的 SIS900 系列所有的硬件，我们不介意 subvendor id 和 sub device id 。你可以加入任何你想要的项目。对于不同的网络卡制造商，它们可能会有不同的 sub vendor id 和 sub device id 。但只要它们用SIS900 这个芯片，那这个驱动程序就可能适用。我们可以说这是一个『公版』的驱动程序。

初始化
好了，那其它的部份呢 ? 还记意 sis900_pci_driver 中其它的二个项目 probe 和remove 吗 ? 它们是用来初始化和移除一个驱动程序的呼叫。你可以把它们想成驱动程序对象的 constructor 和 destructor 。在 probe 中，你应该由硬件中把一些将来可能会用到的资讯准备好。由于这是一个 PCI 驱动程序，你不必特意去检查装置是否真的存在。但如果你的驱动程序只支持某些特定的硬件，或是你想要检查系统中是否有一些特别的硬件存在，你可以在这里做。例如在这个驱动程序中，对不同版本的硬件，我们用不同的方法去读它的 MAC 地址。

pci_read_config_byte(pci_dev, PCI_CLASS_REVISION, &revision);         if (revision == SIS630E_900_REV || revision == SIS630EA1_900_REV)                 ret = sis630e_get_mac_addr(pci_dev, net_dev);         else if (revision == SIS630S_900_REV)                 ret = sis630e_get_mac_addr(pci_dev, net_dev);         else                 ret = sis900_get_mac_addr(pci_dev, net_dev);

对于 SIS630E SIS630EA1 和 SIS630S 这些整合式芯片而言，其 MAC 地址被储存在 APC CMOS RAM 之中。但对其它独立的芯片而言则是存在网络卡的 EEPROM 之上。

为了不要让这篇文章像流水帐一般，我不仔细的说明 probe 的过程。大家自己揣摸一下吧 !

在 probe 中还有一段比较和后文有关的程序码

net_dev->open = &sis900_open;         net_dev->hard_start_xmit = &sis900_start_xmit;         net_dev->stop = &sis900_close;         net_dev->get_stats = &sis900_get_stats;         net_dev->set_config = &sis900_set_config;         net_dev->set_multicast_list = &set_rx_mode;         net_dev->do_ioctl = &mii_ioctl;         net_dev->tx_timeout = sis900_tx_timeout;         net_dev->watchdog_timeo = TX_TIMEOUT;

我想这很清楚，我们透过 net_dev 这个结构告诉 Linux 网络子系统如何来操作这个装置。当你使用 ifconfig 这个 R 令时，系统会使用 sis900_open 打开这个驱动程序，并使用 set_config 来说定装置的参数，如 IP address 。当有资料需要被传送时， sis900_start_xmit 被用来将资料送入装置之中。接下来，我们就一一的检视这些函数。

初始化装置

sis900_open(struct net_device *net_dev);

这个函数会在我们使用 ifconfig 将一网络装置激活时被呼叫。当驱动程序被插入系统之后，通常并不会马上开始接收或传送封包。一般来说，在 probe 的阶段，我们只是单纯的判断装置是否存在。实际激活硬件的动作在这里才会被实际执行。

以 SIS900 为例，在其硬件中只有一个大约 2K 的缓冲区。也就是说在装置上只有一个封包的缓冲区。当一个封包被传送后，装置必须产生一个中断要求操作系统将下一个封包传入。如果由中断到中断驱动程序被执行需要 5ms 的时间，那一秒至多我们可以送出 200 个封包。也就是说网络传送是不可能大于 400K/s ，这对于一般的情况下是不太可能接受的事。

SIS900 虽然在装置上只有很小的缓冲区，但它可以透过 PCI master 模式直接控制主机板上的记忆体。事实上，它使用下面的方式来传送资料。

    

你必须在记忆体中分配一组串接成环状串行的缓冲区，然后将 TXDP 指向缓冲区的第一个地址。 SIS900 会在第一个缓冲区传送完后自动的由第二个缓冲区取资料，并更新记忆中的资料将己传送完缓冲区的 OWN 位清除。当 CPU 将缓冲区串行设定完成后，这个动作可以在完全没有 CPU 的介入下完成。所以硬件不必等待作业系统将新的资料送入，而可以连续的送出多个封包。操作系统只要能来的及让环状串行不会进入空的状态就可以了。

同样的，我们也需要一个接收缓冲区，使用进来的封包不至因操作系统来不及处理而遗失。在 sis900_open 中， sis900_init_rx_ring 和 sis900_init_tx_ring 就是用来负处初始化这二个串行。

在初始化串行之后，我们便可以要求 SIS900 开始接收封包。下面二行程序码便是用来做这件事。

outl((RxSOVR|RxORN|RxERR|RxOK|TxURN|TxERR|TxIDLE), ioaddr + imr);   outl(RxENA, ioaddr + cr);   outl(IE, ioaddr + ier);

第一行设定硬件在下列情况发出一个系统中断，

1. • 接收失败时
   • 接收成功 时
   • 传送失败时
   • 所有缓冲区中的资料都传送完时

第二行则告诉硬件操作系统己经准备好要接收资料了。第三行则时硬件实际开始送出中断。

在这个函数的最后，我们安装一个每秒执行五次的 timer 。在它的处理函数 sis900_timer 中，我们会检查目前的连结状态，这包括了连结的种类 (10/100)和连接的状态 ( 网络卡是否直的被接到网络上去 ) 。

如果各位用过 Window 2000 ，另人印象最深刻的是当你将网络线拔出时， GUI 会自动警言网络己经中断。其实 Linux 也可以做到这件事，只是你需要一个比较好的图形界面就是了。

传送一个封包的 descriptor 给网络卡

sis900_start_xmit(struct sk_buff *skb, struct net_device *net_dev);

这个函数是用来将一个由 skb 描述的网络资料缓冲区送进传送缓冲区中准备传送。其中最重要的程序码为

sis_priv->tx_ring[entry].bufptr = virt_to_bus(skb->data);     sis_priv->tx_ring[entry].cmdsts = (OWN | skb->len);     outl(TxENA, ioaddr + cr);

SIS900 会使用 DMA 由缓冲区中取得封包的资料。由于缓冲区的数目有限，我们必须在缓冲区用完的时后告诉上层的网络协定不要再往下送资料了。在这里我们用下面的程序来做这件事。

if (++sis_priv->cur_tx - sis_priv->dirty_tx < NUM_TX_DESC) {         netif_start_queue(net_dev);     } else {         sis_priv->tx_full = 1;         netif_stop_queue(net_dev);     }

netif_start_queue 用来告诉上层网络协定这个驱动程序还有空的缓冲区可用，请把下一个封包送进来。 netif_stop_queue 则是用来告诉上层网络协定所有的封包都用完了，请不要再送。

接收一个或多个封包

int sis900_rx(struct net_device *net_dev);

这个函式在会在有封包进入系统时被呼叫，因为可能有多于一个的封包在缓冲区之中。这个函数会逐一检查所有的缓冲区，直到遇到一个空的缓冲区为止。

当我们发现一个有资料的缓冲区时，我们需要做二件事。首先是告知上层网络协定有一个新的封包进入系统，这件事由下面的程序完成

skb = sis_priv->rx_skbuff[entry];                skb_put(skb, rx_size);                skb->protocol = eth_type_trans(skb, net_dev);                netif_rx(skb);

前三行根据封包的内容更新 skbuff 中的档头。最后一行则是正式通知上层处理封包。

请注意 Linux 为了增加处理效能，在 netif_rx 并不会真的做完整接收封包的动作，而只是将这个封包记下来。真实的动作是在 bottom half 中才去处理。因为如此，原先储存封包的缓冲区暂时不能再被使用，我们必须重新分配一个新的缓冲区供下一个封包使用。下面的程序码是用来取得一个新的缓冲区。

if ((skb = dev_alloc_skb(RX_BUF_SIZE)) == NULL) {           sis_priv->rx_skbuff[entry] = NULL;           sis_priv->rx_ring[entry].cmdsts = 0;           sis_priv->rx_ring[entry].bufptr = 0;           sis_priv->stats.rx_dropped++;           break;      }      skb->dev = net_dev;      sis_priv->rx_skbuff[entry] = skb;      sis_priv->rx_ring[entry].cmdsts = RX_BUF_SIZE;      sis_priv->rx_ring[entry].bufptr = virt_to_bus(skb->tail);      sis_priv->dirty_rx++;

这个函数其馀的部份其实只是用来记录一些统计资料而己。

传送下一个封包

void sis900_finish_xmit (struct net_device *net_dev);

这个函数用来处理传送中断。在收到一个 TX 中断，表示有一个或多数缓冲区中的资料己经传送完成。我们可以把原先的缓冲区释出来供其它的封包使用，并且用下面的程序告诉上层协定可以送新的封包下来了。

if (sis_priv->tx_full && netif_queue_stopped(net_dev) &&         sis_priv->cur_tx - sis_priv->dirty_tx < NUM_TX_DESC - 4) {         sis_priv->tx_full = 0;         netif_wake_queue (net_dev);     }

netif_wake_queue() 会使得上层协定开始传送新的资料下来。

改变装置的设定

int sis900_set_config(struct net_device *dev, struct ifmap *map);

处理由 ifconfig 送来的命令，在驱动程序中我们通常只处理 media type的改变。这个函数会根据 ifconfig 送来的值改变 MII 控制器的 media tyep ，你可以使用

# ifconfig eth0 media 10basT

将目前的输出入界面强迫改到 10basT 。对于某些自动媒体检测做的有问题的switch 而言这可能是必要的设定，但一般而言默认的 auto 是最好的设定。硬件会自动决定要使用那一个界面，使用者完全不必担心，当实体层的设定改变 ( 例如将网络线插到不同的地方 ) ，硬件会自动侦测并改变设定。

void set_rx_mode(struct net_device *net_dev);

改变目前封包过滤器的模式。当你使用

# ifconfig eth0 promisc       # ifconfig eth0 multicast

等命令时会被呼叫。一般而言，驱动程序的默认值是只接受目的地址和网络卡的 MAC address 相同的封包。你可以透过 ifconfig 命令控制驱动程序接受其它种类的封包。

结语
好了 ! 我己经解析完整个网络卡的驱动程序了。当你了解这个驱动程序后，再去了解其它的驱动程序变成一件很简单的事情。大部份网络驱动程序的架构其实都很类似。事实上， Linux 早期的网络卡驱动程序几乎是由同一个人完成的。而后来的驱动程序也几乎都以这些驱动程序为蓝本，所以看起来都很类似。你要不要也试着再去读另一个网络驱动程序的源代码呢 ? 也许 你会开始抱怨怎幺写驱动程序这幺神秘的东西怎幺变得如此简单了 !

多馀的一节
这一节多馀的，你不想看就算了 :-) 为了证明网络驱动程序之间有多类似我再简略的 trace Intel eepro100 的驱程程序给大家看。不罗唆，马上开始。

初始化

static struct pci_device_id eepro100_pci_tbl[] __devinitdata = {         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82557,                 PCI_ANY_ID, PCI_ANY_ID, },         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82559ER,                 PCI_ANY_ID, PCI_ANY_ID, },         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ID1029,                 PCI_ANY_ID, PCI_ANY_ID, },         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ID1030,                 PCI_ANY_ID, PCI_ANY_ID, },         { PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82820FW_4,                 PCI_ANY_ID, PCI_ANY_ID, },          }; MODULE_DEVICE_TABLE(pci, eepro100_pci_tbl); tatic struct pci_driver eepro100_driver = {         name:           "eepro100",         id_table:       eepro100_pci_tbl,         probe:          eepro100_init_one,         remove:         eepro100_remove_one, #ifdef CONFIG_EEPRO100_PM         suspend:        eepro100_suspend,         resume:         eepro100_resume, #endif }; return pci_module_init(&eepro100_driver);

嗯 ! 一切都不出意类之外，是吧 !

初始化装置

eepro100_init_one()

这个看起来比 SIS900 的复杂多了。不过几个关鉴的函数还是一样，只是它的程序码看起比较乱。 BSD 的人喜欢说 Linux 的程序码太乱 ! 嗯，好象不承认不行 :-) 不过我说它乱的很可爱，行了吧 !

传送封包

speedo_start_xmit(struct sk_buff *skb, struct net_device *dev)

这个函数相似到我不必做任何讲解，也不必有任何文件你就可以知道它在做些什幺事了 ! 程序码几乎到了一行对一行的程度 ( 夸张了一点 ! 不过很接近事实。我信相 SIS900 的 driver 是很整个程序 copy 过去再修改的 )

中断处理

void speedo_interrupt(int irq, void *dev_instance, struct pt_regs *regs);

这个函数，我再喜欢 Linux 也不得不抱怨一下了。 Donald Becker 先生，能麻烦程序写的好看一点好吗 ?

基本上，它把 sis900_rx 的内容直接放在中断处理函数之中。不过我想分开还是会清楚一些。

speedo_tx_buffer_gc 基本上就是 sis900_finish_xmit 。下面的程序是不是很眼熟呢 ?

dirty_tx = sp->dirty_tx;      while ((int)(sp->cur_tx - dirty_tx) > 0) {         int entry = dirty_tx % TX_RING_SIZE;         int status = le32_to_cpu(sp->tx_ring[entry].status);         }

连变数名字都很像呢 !

不过 eepro100 的驱动程序没有实作 set_config 的界面，所以你不能用ifconfig 来改变 media type 。不过 eepro100 提供了由模块命令列选项改变的功 能，当然它是不及 set_config 来的方便就是了。

还要再来一个吗 ? 你自己去做吧 !!!