linux網絡裝置驅動DM9000驅動分析（1）

  轉載請注明出處：http://blog.csdn.net/gotowu/article/details/46329809

  本文所分析的DM9000驅動，是基于platform裝置模型的。

網絡驅動程式不再是對檔案進行操作，而是由專門的網絡接口struct net_device來實作。應用程式不能直接通路網絡驅動程式，隻能由網絡字系統與它互動。此外，不像字元裝置和塊裝置在/dev目錄下有一個特殊檔案來表示該裝置，網絡裝置沒有這樣的入口點。

首先，在網絡驅動程式中，有兩個很重要的結構體分别是net_device和sk_buff。；

1、skb_buf

它是Linux在其協定棧裡傳送的結構體，也就是所謂的“包”，在他裡面包含了各層協定的頭部，比如ethernet, ip ,tcp ,udp等等. sk_buff是一個複雜的雙向連結清單，在他結構中有next和prev指針，分别指向連結清單的下一個節點和前一個節點。該結構在核心源碼的include/linux/skbuff.h檔案中定義.

2、net_device

net_device是網絡裝置驅動的核心，包含網絡擴充卡的硬體資訊（中斷、端口、驅動程式函數等）和高層網絡協定的網絡配置資訊（IP位址、子網路遮罩等）。該結構的定義位于include/linux/netdevice.h。

一、子產品的注冊和加載。

1、子產品的注冊，使用platform_driver_register，将子產品注冊進核心。

static int __init dm9000_init(void)
{
	printk(KERN_INFO "%s Ethernet Driver, V%s\n", CARDNAME, DRV_VERSION);

	return platform_driver_register(&dm9000_driver);
}
           

2、填充platform_driver 結構體，其中包括用去match的驅動名字以及probe等操作函數。

static struct platform_driver dm9000_driver = {
	.driver	= {
		.name    = "dm9000",                                   //若核心中有相同名稱的平台裝置，則調用probe函數
		.owner	 = THIS_MODULE,
		.pm	 = &dm9000_drv_pm_ops,
	},
	.probe   = dm9000_probe,
	.remove  = __devexit_p(dm9000_drv_remove),
};
           

3、下面來看看很重要的probe函數，該函數主要完成了探測裝置，對網絡裝置的初始化，擷取資源，申請中斷，映射實體位址，讀取MAC位址和注冊net_device結構體。

先來看幾個函數吧：

（1）alloc_etherdev 初始化一個網絡裝置最終是調用了函數alloc_netdev_mq,因為對以太網裝置來講，很多操作與屬性是固定的，核心可以幫助完成。

（2）request_mem_region這個函數向核心申請n個記憶體位址,這些位址從first 開始,name參數為裝置的名稱。如果配置設定成功傳回值是非  NULL，如果傳回NULL，則意味着申

請I/O 記憶體失敗.

（3）ioremap()将裝置所處的實體位址映射為虛拟位址，并且傳回一個特殊的虛拟位址

該位址可以用來存取特點的實體位址範圍

static int __devinit
dm9000_probe(struct platform_device *pdev)
{
	struct dm9000_plat_data *pdata = pdev->dev.platform_data;
	struct board_info *db;	/* Point a board information structure */
	struct net_device *ndev;
	const unsigned char *mac_src;
	int ret = 0;
	int iosize;
	int i;
	u32 id_val;

	//初始化一個網絡裝置最終是調用了函數alloc_netdev_mq,因為對以太網裝置來講，
	//很多操作與屬性是固定的，核心可以幫助完成。
	ndev = alloc_etherdev(sizeof(struct board_info));                   
	if (!ndev)
		return -ENOMEM;
        //建立net_device到device的連接配接
	SET_NETDEV_DEV(ndev, &pdev->dev);

	dev_dbg(&pdev->dev, "dm9000_probe()\n");

	db = netdev_priv(ndev);        //函數netdev_priv直接傳回了net_device結構末端位址,
                                       //也就是網卡私有資料結構的起始位址.
	db->dev = &pdev->dev;
	db->ndev = ndev;

	spin_lock_init(&db->lock);
	mutex_init(&db->addr_lock);

	INIT_DELAYED_WORK(&db->phy_poll, dm9000_poll_work);

	db->addr_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);      //擷取資源賦給位址、資料、中斷
	db->data_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);    //記憶體位址空間定義在闆級檔案common-smdk.c
	db->irq_res  = platform_get_resource(pdev, IORESOURCE_IRQ, 0);

	if (db->addr_res == NULL || db->data_res == NULL ||
	    db->irq_res == NULL) {
		dev_err(db->dev, "insufficient resources\n");
		ret = -ENOENT;
		goto out;
	}
	
	//内部調用了platform_get_resource，擷取一個裝置irq，這個irq号也是闆級配置檔案中設定的
	db->irq_wake = platform_get_irq(pdev, 1);                  
	if (db->irq_wake >= 0) {
		dev_dbg(db->dev, "wakeup irq %d\n", db->irq_wake);

		ret = request_irq(db->irq_wake, dm9000_wol_interrupt,   //中斷裝置申請
				  IRQF_SHARED, dev_name(db->dev), ndev);
		if (ret) {
			dev_err(db->dev, "cannot get wakeup irq (%d)\n", ret);
		} else {

			/* test to see if irq is really wakeup capable */
			ret = irq_set_irq_wake(db->irq_wake, 1);            //使能IRQ的電源管理喚醒模式
			if (ret) {                                          //使系統能從睡眠态喚醒
				dev_err(db->dev, "irq %d cannot set wakeup (%d)\n",
					db->irq_wake, ret);
				ret = 0;
			} else {
				irq_set_irq_wake(db->irq_wake, 0);       //不使能IRQ的電源管理喚醒模式
				db->wake_supported = 1;
			}
		}
	}

	iosize = resource_size(db->addr_res);               //擷取addr_res的長度大小
	db->addr_req = request_mem_region(db->addr_res->start, iosize, //向核心申請記憶體位址
					  pdev->name);
	
	if (db->addr_req == NULL) {
		dev_err(db->dev, "cannot claim address reg area\n");
		ret = -EIO;
		goto out;
	}

	db->io_addr = ioremap(db->addr_res->start, iosize);  //将addr_res在platform_get_resource擷取的實體位址映射為虛拟位址

	if (db->io_addr == NULL) {
		dev_err(db->dev, "failed to ioremap address reg\n");
		ret = -EINVAL;
		goto out;
	}

	iosize = resource_size(db->data_res);
	db->data_req = request_mem_region(db->data_res->start, iosize,
					  pdev->name);

	if (db->data_req == NULL) {
		dev_err(db->dev, "cannot claim data reg area\n");
		ret = -EIO;
		goto out;
	}

	db->io_data = ioremap(db->data_res->start, iosize);

	if (db->io_data == NULL) {
		dev_err(db->dev, "failed to ioremap data reg\n");
		ret = -EINVAL;
		goto out;
	}
	//上面因為dm9000提供了位址和資料兩個通路口，是以映射了兩個
	
	ndev->base_addr = (unsigned long)db->io_addr;  //網絡接口的IO基位址
	ndev->irq	= db->irq_res->start;   //中斷号  ifconfig時會列印出這個值  也可通過這個修改
	
//設定dm9000位寬，根據闆級配置檔案中struct platform_data設定而定 
	dm9000_set_io(db, iosize);

	if (pdata != NULL) {
		/* check to see if the driver wants to over-ride the
		 * default IO width */
//檢測與闆級資訊是否相同
		if (pdata->flags & DM9000_PLATF_8BITONLY)
			dm9000_set_io(db, 1);

		if (pdata->flags & DM9000_PLATF_16BITONLY)
			dm9000_set_io(db, 2);

		if (pdata->flags & DM9000_PLATF_32BITONLY)
			dm9000_set_io(db, 4);

		/* check to see if there are any IO routine
		 * over-rides */
	                                             /*inblk :IO模式*/
		if (pdata->inblk != NULL)            //若pdata->inblk != NULL則對上面的dm9000_set_io設定的值重新指派
			db->inblk = pdata->inblk;   //否則就使用上面的dm9000_set_io設定的值
								    //此處為什麼這樣???
		if (pdata->outblk != NULL)
			db->outblk = pdata->outblk;

		if (pdata->dumpblk != NULL)
			db->dumpblk = pdata->dumpblk;

		db->flags = pdata->flags;
	}

#ifdef CONFIG_DM9000_FORCE_SIMPLE_PHY_POLL
	db->flags |= DM9000_PLATF_SIMPLE_PHY;
#endif

	dm9000_reset(db);       //複位操作，初始化NCR網絡控制寄存器
/*此處的複位操作我的了解是，當我們開始運作後，對db的一些成員進行
*了設定後，就要進行複位，對DM9000晶片進行重新開機，然後重新讀取
*晶片中的資料，比如mac位址，VID或者PID等。
*/

	for (i = 0; i < 8; i++) {                    //讀取DM9000的寄存器
		id_val  = ior(db, DM9000_VIDL);      //讀一下生産商和制造商的ID
		id_val |= (u32)ior(db, DM9000_VIDH) << 8;    //根據DM9000datasheet中的VIDL位址讀取
		id_val |= (u32)ior(db, DM9000_PIDL) << 16;
		id_val |= (u32)ior(db, DM9000_PIDH) << 24;

		if (id_val == DM9000_ID)
			break;
		dev_err(db->dev, "read wrong id 0x%08x\n", id_val);
	}

	if (id_val != DM9000_ID) {
		dev_err(db->dev, "wrong id: 0x%08x\n", id_val);
		ret = -ENODEV;
		goto out;
	}

	/* Identify what type of DM9000 we are working on */

	id_val = ior(db, DM9000_CHIPR);            //讀一下晶片的類型    
	dev_dbg(db->dev, "dm9000 revision 0x%02x\n", id_val);

	switch (id_val) {
	case CHIPR_DM9000A:
		db->type = TYPE_DM9000A;
		break;
	case CHIPR_DM9000B:
		db->type = TYPE_DM9000B;
		break;
	default:
		dev_dbg(db->dev, "ID %02x => defaulting to DM9000E\n", id_val);
		db->type = TYPE_DM9000E;
	}

	/* dm9000a/b are capable of hardware checksum offload */
	if (db->type == TYPE_DM9000A || db->type == TYPE_DM9000B) {
		ndev->hw_features = NETIF_F_RXCSUM | NETIF_F_IP_CSUM;
		ndev->features |= ndev->hw_features;
	}

	/* from this point we assume that we have found a DM9000 */

	/* driver system function */
	ether_setup(ndev);//在調用register_netdev之前必須初始化完全。該函數中為net_device設定了很多預設值

	ndev->netdev_ops	= &dm9000_netdev_ops;
	ndev->watchdog_timeo	= msecs_to_jiffies(watchdog);
	ndev->ethtool_ops	= &dm9000_ethtool_ops;
        //dm9000網卡的初始化,提供了這些，對phy的操作就可以用mii.c中的函數去操作
	db->msg_enable       = NETIF_MSG_LINK;
	db->mii.phy_id_mask  = 0x1f;          //這個給驅動用，dm9000沒用，是考慮smi總線上有多個phy時。
	db->mii.reg_num_mask = 0x1f;
	db->mii.force_media  = 0;
	db->mii.full_duplex  = 0;
	db->mii.dev	     = ndev;
	db->mii.mdio_read    = dm9000_phy_read;
	db->mii.mdio_write   = dm9000_phy_write;

	mac_src = "eeprom";

	/* try reading the node address from the attached EEPROM */
	for (i = 0; i < 6; i += 2)
		dm9000_read_eeprom(db, i / 2, ndev->dev_addr+i);   //讀取MAC位址，并儲存在ndev->dev_addr中

	if (!is_valid_ether_addr(ndev->dev_addr) && pdata != NULL) {
		mac_src = "platform data";
		memcpy(ndev->dev_addr, pdata->dev_addr, 6);
	}

	if (!is_valid_ether_addr(ndev->dev_addr)) {
		/* try reading from mac */
		
		mac_src = "chip";
		for (i = 0; i < 6; i++)
			ndev->dev_addr[i] = ior(db, i+DM9000_PAR);    //PAR :實體位址mac寄存器,用來儲存6個位元組的MAC位址
	}

	if (!is_valid_ether_addr(ndev->dev_addr)) {
		dev_warn(db->dev, "%s: Invalid ethernet MAC address. Please "
			 "set using ifconfig\n", ndev->name);

		eth_hw_addr_random(ndev);     //産生一個随機的MAC位址給net_device
		mac_src = "random";
	}

//把ndev儲存為平台裝置pdev的私有資料，并可以調用platform_get_drvdata擷取該資料 
	platform_set_drvdata(pdev, ndev);
	ret = register_netdev(ndev);            //注冊net_device結構體

	if (ret == 0)
		printk(KERN_INFO "%s: dm9000%c at %p,%p IRQ %d MAC: %pM (%s)\n",
		       ndev->name, dm9000_type_to_char(db->type),
		       db->io_addr, db->io_data, ndev->irq,
		       ndev->dev_addr, mac_src);
	return 0;

out:
	dev_err(db->dev, "not found (%d).\n", ret);

	dm9000_release_board(pdev, db);
	free_netdev(ndev);

	return ret;
}