1. 函数dm9000_probe()函数的执行,DM9000这颗网络IC的驱动正式开始.此函数的执行完毕,即意味着整个DM9000处于准备就绪状态,安静地等待着上层的网络操作.
/*
* Search DM9000 board, allocate space and register it
*/
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;
/* Init network device */
ndev = alloc_etherdev(sizeof(struct board_info));
if (!ndev) {
dev_err(&pdev->dev, "could not allocate device.\n");
return -ENOMEM;
}
SET_NETDEV_DEV(ndev, &pdev->dev);
dev_dbg(&pdev->dev, "dm9000_probe()\n");
/* setup board info structure */
db = netdev_priv(ndev);
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);
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;
}
iosize = resource_size(db->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);
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;
}
/* fill in parameters for net-dev structure */
ndev->base_addr = (unsigned long)db->io_addr;
ndev->irq = db->irq_res->start;
/* ensure at least we have a default set of IO routines */
dm9000_set_io(db, iosize);
/* check to see if anything is being over-ridden */
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 */
if (pdata->inblk != NULL)
db->inblk = pdata->inblk;
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);
/* try multiple times, DM9000 sometimes gets the read wrong */
for (i = 0; i < 8; i++) {
id_val = ior(db, DM9000_VIDL);
id_val |= (u32)ior(db, DM9000_VIDH) << 8;
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) {
db->can_csum = 1;
db->rx_csum = 1;
ndev->features |= NETIF_F_IP_CSUM;
}
/* from this point we assume that we have found a DM9000 */
/* driver system function */
ether_setup(ndev);
ndev->netdev_ops = &dm9000_netdev_ops;
ndev->watchdog_timeo = msecs_to_jiffies(watchdog);
ndev->ethtool_ops = &dm9000_ethtool_ops;
db->msg_enable = NETIF_MSG_LINK;
db->mii.phy_id_mask = 0x1f;
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);
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);
}
if (!is_valid_ether_addr(ndev->dev_addr))
dev_warn(db->dev, "%s: Invalid ethernet MAC address. Please "
"set using ifconfig\n", ndev->name);
platform_set_drvdata(pdev, ndev);
ret = register_netdev(ndev);
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;
}
1-1.函数参数:
看一下函数当然从函数参数看起.
static int __devinit dm9000_probe(struct platform_device *pdev)
pdev即为平台设备,即:
static struct platform_device mini2440_device_eth __initdata = {
.name = "dm9000",
.id = -1,
.num_resources = ARRAY_SIZE(mini2440_dm9k_resource),
.resource = mini2440_dm9k_resource,
.dev = {
.platform_data = &mini2440_dm9k_pdata,
},
};
1-2.临时变量:
一个函数(尤其是内核的函数)的临时变量,是很重要的,往往是用来把平台相关的信息打包成内核子系统需要的结构体然后跟内核子系统交互,把子系统初始化为目标平台相关的.以前用户空间通过子系统间接实现和平台相关硬件的交互.
1-2-1.
struct dm9000_plat_data *pdata = pdev->dev.platform_data;
pdata指向的是:
static struct dm9000_plat_data mini2440_dm9k_pdata __initdata = {
.flags = (DM9000_PLATF_16BITONLY | DM9000_PLATF_NO_EEPROM),
};
1-2-2.
struct board_info *db; /* Point a board information structure */
平台相关的私有结构,是指向具体平台的信息体.对于内核而言,一个完整的以太网设备的内核表征有两大部分组成:struct net_device + struct board_info.如下图所示:
黑色框表示一段内存,分两部分:一部分是用于和内核网络子系统交互的net_device;另一部分是平台相关的board_info.而且有个指针db是专门指向board_info的起始位置的.
1-2-3.
struct net_device *ndev;
内核网络子系统中最核心的数据结构是也.
1-2-4.
const unsigned char *mac_src;
int ret = 0;
int iosize;
int i;
u32 id_val;
这些只是纯粹的临时变量,不细说.
1-3.
ndev = alloc_etherdev(sizeof(struct board_info));
此函数作用主要有下:
1-3-1.
分配net_device和board_info.实现上述1-2-2的网络内存示意图:
alloc_size = sizeof(struct net_device);
if (sizeof_priv) {
/* ensure 32-byte alignment of private area */
alloc_size = ALIGN(alloc_size, NETDEV_ALIGN);
alloc_size += sizeof_priv;
}
/* ensure 32-byte alignment of whole construct */
alloc_size += NETDEV_ALIGN - 1;
p = kzalloc(alloc_size, GFP_KERNEL);
1-3-2.
命名网络接口的名字,如ethn(n = 0,1,2...):
strcpy(dev->name, name);
当然这里只是命名的第一步,ethn中的n还是没有指定的.
1-3-3.
通过回调函数void ether_setup(struct net_device *dev)来填充分配出来的net_device,设置以太网通用的操作:
/**
* ether_setup - setup Ethernet network device
* @dev: network device
* Fill in the fields of the device structure with Ethernet-generic values.
*/
void ether_setup(struct net_device *dev)
{
dev->header_ops = ð_header_ops;
dev->type = ARPHRD_ETHER;
dev->hard_header_len = ETH_HLEN;
dev->mtu = ETH_DATA_LEN;
dev->addr_len = ETH_ALEN;
dev->tx_queue_len = 1000; /* Ethernet wants good queues */
dev->flags = IFF_BROADCAST|IFF_MULTICAST;
memset(dev->broadcast, 0xFF, ETH_ALEN);
}
如:
接口的硬件类型为ARPHRD_ETHER,表示10Mbps速率的;
以太网头的octet(实际是一个字节)为ETH_HLEN;
最大的传输单元mtu为ETH_DATA_LEN;
一个网络设备的mac地址的大小为ETH_ALEN;
每个网络队列的最大帧为1000;
允许广播并支持多路广播.
基本都是以太网协议标准的东西.
1-3-4.
绑定这个net_device接收发送队列.
1-3-5.
小结:
从入口函数:
ndev = alloc_etherdev(sizeof(struct board_info));
可知,我们只传递了一个数据大小的值给函数alloc_etherdev(),而且此函数是平台无关性的.因此,略过吧.
1-4.
INIT_DELAYED_WORK(&db->phy_poll, dm9000_poll_work);
初始化DM9000用到的工作队列.后续分析工作队列再涉及到此处的分析.此工作队列在此主要是检测链中是否正常.
1-5.
db->addr_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
db->data_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
db->irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
注意这里拿到的地址是物理地址,内核空间不能对物理地址直接操作,必须通过ioremap()映射成虚拟地址.因此,我们将看到下面的代码:
db->io_addr = ioremap(db->addr_res->start, iosize);
db->io_data = ioremap(db->data_res->start, iosize);
1-6.
if (pdata->flags & DM9000_PLATF_16BITONLY)
dm9000_set_io(db, 2);
我们与DM9000连接的位宽为16bit.
1-7.
dm9000_reset(db);
DM9000的复位,主要根据DM9000的数据手册提供的访问协议来完成软件复位,这在之二有作分析.
1-8.
ether_setup(ndev);
利用系统提供的这个API来完成大部分以太网协议标准通用的初始化,其实上述在回调中已经有调用此函数了.
1-9.
ndev->netdev_ops = &dm9000_netdev_ops;
用具体的PHY(这里是DM9000)来初始化这颗net_device:
static const struct net_device_ops dm9000_netdev_ops = {
.ndo_open = dm9000_open,
.ndo_stop = dm9000_stop,
.ndo_start_xmit = dm9000_start_xmit,
.ndo_tx_timeout = dm9000_timeout,
.ndo_set_multicast_list = dm9000_hash_table,
.ndo_do_ioctl = dm9000_ioctl,
.ndo_change_mtu = eth_change_mtu,
.ndo_validate_addr = eth_validate_addr,
.ndo_set_mac_address = eth_mac_addr,
#ifdef CONFIG_NET_POLL_CONTROLLER
.ndo_poll_controller = dm9000_poll_controller,
#endif
};
这个是具体设备(DM9000)相关的,用户空间操作DM9000,首先响应的是网络子系统,然后网络子系统再路由此和具体的PHY打交道.例如用户空间执行ifconfig命令时激活网络接口,open会被调用,复位PHY、初始化PHY、申请中断等动作便是在此完成.当用户空间操作网络接口,如send()、recv()等系统调用时,便会路由至.
1-10.
ndev->watchdog_timeo = msecs_to_jiffies(watchdog);
网络超时控制.如果网络出现延误阻塞而出现超时,驱动应该采取一些措施.
1-11.
ndev->ethtool_ops = &dm9000_ethtool_ops;
用户空间的网络工具ethtool是用来管理控制网络接口的工具,底层对应的就是ethtool_ops.当这个接口被实现了,使用ethtool工具可以控制速度、介质类型、DMA设置、硬件校验、LAN唤醒等动作.
1-12.
db->mii.phy_id_mask = 0x1f;
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;
如果DM9000有接MII设备,可以通过此接口访问DM9000上挂载的MII设备.
1-13.
dm9000_read_eeprom(db, i / 2, ndev->dev_addr+i);
读DM9000上面挂载的EEPROM(如果有的话)的数据.
1-14.
if (!is_valid_ether_addr(ndev->dev_addr) && pdata != NULL) {
判断MAC地址的有效性.
1-15.
platform_set_drvdata(pdev, ndev);
把平台相关信息体pdev->dev->p->driver_data指向net_device,方便后续的软件找到彼此.
1-16.
ret = register_netdev(ndev);
通过层层初始化,从这一函数开始,便走进了内核网络子系统的世界.