Linux網路設備驅動編程

Tg3 Gbit NIC Driver Analysis
在此僅僅討論網路設備驅動的一般寫法，有關硬體部分的相關代碼由於硬體規格不同，予以省略。有什麼地方錯誤，或補充，歡迎大家提出。

1, 驅動模塊的載入和卸載
如果網路設備（包括wireless）是PCI規範的，則先是向內核註冊該PCI設備(pci_register_driver)，然後由pci_driver數據結構中的probe函數指針所指向的偵測函數來初始化該PCI設備，並且同時註冊和初始化該網路設備。
如果網路設備（包括wireless）是PCMCIA規範的，則先是向內核註冊該PCMCIA設備(register_pccard_driver)，然後driver_info_t數據結構中的attach函數指針所指向的偵測函數來初始化該PCMCIA設備，並且同時註冊和初始化該網路設備。

static int __init tg3_init(void)
{
//先註冊成PCI設備，並初始化，如果是其他的ESIA，PCMCIA，用其他函數
return pci_module_init(&tg3_driver);
}

static void __exit tg3_cleanup(void)
{
pci_unregister_driver(&tg3_driver);//註銷PCI設備
}

module_init(tg3_init); //驅動模塊的載入
module_exit(tg3_cleanup); //驅動模塊的卸載

申明為PCI設備：
static struct pci_driver tg3_driver = {
.name = DRV_MODULE_NAME,
.id_table = tg3_pci_tbl, //此驅動所支持的網卡系列，vendor_id, device_id
.probe = tg3_init_one, //初始化網路設備的回調函數
.remove = __devexit_p(tg3_remove_one), //註銷網路設備的回調函數
.suspend = tg3_suspend, //設備掛起函數
.resume = tg3_resume //設備恢複函數
};

2，PCI設備探測函數probe，初始化網路設備
static int __devinit tg3_init_one(struct pci_dev *pdev, const struct pci_device_id *ent)
{
//初始化設備，使I/O，memory可用，喚醒設備
pci_enable_device(pdev);
//申請內存空間，配置網卡的I/O，memory資源
pci_request_regions(pdev, DRV_MODULE_NAME);
pci_set_master(pdev);
//設置DMA屬性
pci_set_dma_mask(pdev, (u64) 0xffffffffffffffff);
//網卡 I/O,memory資源的啟始地址
tg3reg_base = pci_resource_start(pdev, 0);
//網卡I/O,memory資源的大小
tg3reg_len = pci_resource_len(pdev, 0);
//分配並設置網路設備
dev = alloc_etherdev(sizeof(*tp));
//申明為內核設備模塊
SET_MODULE_OWNER(dev);
//初始化私有結構中的各成員值
tp = dev->priv;
tp->pdev = pdev;
tp->dev = dev;
……
//鎖的初始化
spin_lock_init(&tp->lock);
//映射I/O,memory地址到私有域中的寄存器結構
tp->regs = (unsigned long) ioremap(tg3reg_base, tg3reg_len);
dev->irq = pdev->irq;
//網路設備回調函數賦值
dev->open = tg3_open;
dev->stop = tg3_close;
dev->get_stats = tg3_get_stats;
dev->set_multicast_list = tg3_set_rx_mode;
dev->set_mac_address = tg3_set_mac_addr;
dev->do_ioctl = tg3_ioctl;
dev->tx_timeout = tg3_tx_timeout;
dev->hard_start_xmit= tg3_start_xmit;
//網卡的MAC地址賦值dev->addr
tg3_get_device_address(tp);
//註冊網路設備
register_netdev(dev);
//把網路設備指針地址放入PCI設備中的設備指針中
pci_set_drvdata(pdev, dev);
}

3，註銷網路設備
static void __devexit tg3_remove_one(struct pci_dev *pdev)
{
struct net_device *dev = pci_get_drvdata(pdev);
//註銷網路設備
unregister_netdev(dev);
//取消地址映射
iounmap((void *) ((struct tg3 *)(dev->priv))->regs);
//釋放網路設備
kfree(dev);
//釋放PCI資源
pci_release_regions(pdev);
//停用PCI設備
pci_disable_device(pdev);
//PCI設備中的設備指針賦空
pci_set_drvdata(pdev, NULL);
}

4，打開網路設備
static int tg3_open(struct net_device *dev)
{
//分配一個中斷
request_irq(dev->irq, tg3_interrupt, SA_SHIRQ, dev->name, dev);
/* int request_irq(unsigned int irq,
void (*handler)(int irq, void *dev_id, struct pt_regs *regs),
unsigned long irqflags,
const char * devname,
void *dev_id);
irq是要申請的硬體中斷號。在Intel平台，範圍0--15。handler是向系統登記的中斷處理函數。這是一個回調函數，中斷髮生時，系統調用這個函數，傳入的參數包括硬體中斷號，device id，寄存器值。dev_id就是下面的request_irq時傳遞給系統的參數dev_id。irqflags是中斷處理的一些屬性。比較重要的有SA_INTERRUPT，標明中斷處理程序是快速處理程序(設置SA_INTERRUPT)還是慢速處理程序(不設置SA_INTERRUPT)。快速處理程序被調用時屏蔽所有中斷。慢速處理程序不屏蔽。還有一個SA_SHIRQ屬性，設置了以後運行多個設備共享中斷。dev_id在中斷共享時會用到。一般設置為這個設備的device結構本身或者NULL。中斷處理程序可以用dev_id找到相應的控制這個中斷的設備，或者用rq2dev_map找到中斷對應的設備。*/
//初始化硬體
tg3_init_hw(tp);
//初始化收包和發包的緩衝區
tg3_init_rings(tp);
//初始化定時器
init_timer(&tp->timer);
tp->timer.expires = jiffies + tp->timer_offset;
tp->timer.data = (unsigned long) tp;
tp->timer.function = tg3_timer; //超時回調函數
add_timer(&tp->timer);
//允許網卡開始傳輸包
netif_start_queue(dev);
}

5，關閉網路設備
static int tg3_close(struct net_device *dev)
{
//停止網卡傳輸包
netif_stop_queue(dev);
netif_carrier_off(tp->dev);
//去除定時器
del_timer_sync(&tp->timer);
//釋放收包和發包的緩衝區
tg3_free_rings(tp);
//釋放中斷
free_irq(dev->irq, dev);
}

6，硬體處理數據包發送
static int tg3_start_xmit(struct sk_buff *skb, struct net_device *dev)
{
len = (skb->len - skb->data_len);
//以DMA方式向網卡物理設備傳輸包。如果是wireless的話，需要根據802.11協議及硬體的規範從新填充
//硬體幀頭，然後提交給硬體發送。
mapping = pci_map_single(tp->pdev, skb->data, len, PCI_DMA_TODEVICE);
tp->tx_buffers[entry].skb = skb;
pci_unmap_addr_set(&tp->tx_buffers[entry], mapping, mapping);
//硬體發送
tg3_set_txd(tp, entry, mapping, len, base_flags, mss_and_is_end);
//記錄發包開始時間
dev->trans_start = jiffies;
}

7，中斷處理收包，發包
static void tg3_interrupt(int irq, void *dev_id, struct pt_regs *regs)
{
//如果要收包
tg3_rx(tp);
//如果要發包
tg3_tx(tp);
}

8，發包
static void tg3_tx(struct tg3 *tp)
{
struct tx_ring_info *ri = &tp->tx_buffers[sw_idx];
struct sk_buff *skb = ri->skb;
//以DMA方式向網卡傳輸包完畢
pci_unmap_single(tp->pdev, pci_unmap_addr(ri, mapping),
(skb->len - skb->data_len), PCI_DMA_TODEVICE);
ri->skb = NULL;
dev_kfree_skb_irq(skb);
}
9，收包
static int tg3_rx(struct tg3 *tp, int budget)
{
struct sk_buff *copy_skb;
//分配一個包
copy_skb = dev_alloc_skb(len + 2);
copy_skb->dev = tp->dev;
//修改包頭空間
skb_reserve(copy_skb, 2);
//加入數據到包中
skb_put(copy_skb, len);
//以DMA方式從網卡傳輸回數據
pci_dma_sync_single(tp->pdev, dma_addr, len, PCI_DMA_FROMDEVICE);
memcpy(copy_skb->data, skb->data, len);
skb = copy_skb;
//解析包的協議
skb->protocol = eth_type_trans(skb, tp->dev);
//把包送到協議層
netif_rx(skb);
//記錄收包時間
tp->dev->last_rx = jiffies;
}

10, 讀取包的網卡收發包的狀態，統計數據
static struct net_device_stats *tg3_get_stats(struct net_device *dev)
{
//從硬體相關的寄存器讀取數據，累加
//stats->rx_packets, stats->tx_packets, stats->rx_bytes, stats->tx_bytes等
}

11, 用戶的ioctl命令系統調用
static int tg3_ioctl(struct net_device *dev, struct ifreq *ifr, int cmd)
{
struct mii_ioctl_data *data = (struct mii_ioctl_data *)&ifr->ifr_data;
switch(cmd) {
//ethtool程序命令的調用
case SIOCETHTOOL:
return tg3_ethtool_ioctl(dev, (void *) ifr->ifr_data);
//mii程序命令的調用
case SIOCGMIIREG: {
err = tg3_readphy(tp, data->reg_num & 0x1f, &mii_regval)
data->val_out = mii_regval;
return err;
}
……
}
}

12, PCI設備的掛起和恢複函數
static int tg3_suspend(struct pci_dev *pdev, u32 state)
{
//停用網卡的中斷寄存器
tg3_disable_ints(tp);
//停止網卡收發包
netif_device_detach(dev);
//停止網卡某些硬體，fireware的一些功能
tg3_halt(tp);
//設置網卡的電源狀態
tg3_set_power_state(tp, state);
}

static int tg3_resume(struct pci_dev *pdev)
{
//恢復網卡電源
tg3_set_power_state(tp, 0);
//允許網卡收發包
netif_device_attach(dev);
//初始化收發包的緩衝區
tg3_init_rings(tp);
//初始化網卡硬體
tg3_init_hw(tp);
//打開網卡中斷寄存器
tg3_enable_ints(tp);
}

13，參數設置
在驅動程序里還提供一些方法供系統對設備的參數進行設置和讀取信息。一般只有超級用戶(root)許可權才能對設備參數進行設置。設置方法有：
tg3_set_mac_addr (dev->set_mac_address)
當用戶調用ioctl類型為SIOCSIFHWADDR時是要設置這個設備的mac地址。一般對mac地址的設置沒有太大意義的。

dev->set_config()
當用戶調用ioctl時類型為SIOCSIFMAP時，系統會調用驅動程序的set_config方法
用戶會傳遞一個ifmap結構包含需要的I/O、中斷等參數。

總結：
所有的Linux網路驅動程序遵循通用的介面。設計時採用的是面向對象的方法。一個設備就是一個對象(net_device 結構)，它內部有自己的數據和方法。一個網路設備最基本的方法有初始化,發送和接收。
Linux網路驅動程序的體系結構可以劃分為四層：
網路協議介面，網路設備介面，設備驅動功能，網路設備和網路媒介層
網路驅動程序，最主要的工作就是完成設備驅動功能層。在Linux中所有網路設備都抽象為一個介面，這個介面提供了對所有網路設備的操作集合。由數據結構struct net_device來表示網路設備在內核中的運行情況，即網路設備介面。它既包括純軟體網路設備介面，如環路（Loopback），也包括硬體網路設備介面，如乙太網卡。而由以dev_base為頭指針的設備鏈表來集體管理所有網路設備，該設備鏈表中的每個元素代表一個網路設備介面。數據結構net_device中有很多供系統訪問和協議層調用的設備方法，包括初始化,打開和關閉網路設備的open和stop函數，處理數據包發送的hard_start_xmit函數，以及中斷處理函數等。
網路設備在Linux里做專門的處理。Linux的網路系統主要是基於BSD unix的socket機制。在系統和驅動程序之間定義有專門的數據結構(sk_buff)進行數據的傳遞。系統里支持對發送數據和接收數據的緩存，提供流量控制機制，提供對多協議的支持。