转：DM9000驱动解析

1. /*
2. *   dm9000.c: Version 1.2 03/18/2003
3. *
4. *         A Davicom DM9000 ISA NIC fast Ethernet driver for Linux.
5. * Copyright (C) 1997 Sten Wang
6. *
7. * This program is free software; you can redistribute it and/or
8. * modify it under the terms of the GNU General Public License
9. * as published by the Free Software Foundation; either version 2
10. * of the License, or (at your option) any later version.
11. *
12. * This program is distributed in the hope that it will be useful,
13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15. * GNU General Public License for more details.
16. *
17. *   (C)Copyright 1997-1998 DAVICOM Semiconductor,Inc. All Rights Reserved.
18. *
19. * V0.11 06/20/2001 REG_0A bit3=1, default enable BP with DA match
20. * 06/22/2001 Support DM9801 progrmming
21. * E3: R25 = ((R24 + NF) & 0x00ff) | 0xf000
22. *    E4: R25 = ((R24 + NF) & 0x00ff) | 0xc200
23. *           R17 = (R17 & 0xfff0) | NF + 3
24. *    E5: R25 = ((R24 + NF - 3) & 0x00ff) | 0xc200
25. *           R17 = (R17 & 0xfff0) | NF
26. *
27. * v1.00               modify by simon 2001.9.5
28. *                         change for kernel 2.4.x
29. *
30. * v1.1   11/09/2001      fix force mode bug
31. *
32. * v1.2   03/18/2003       Weilun Huang <weilun_huang@davicom.com.tw>:
33. *     Fixed phy reset.
34. *     Added tx/rx 32 bit mode.
35. *     Cleaned up for kernel merge.
36. *
37. *        03/03/2004    Sascha Hauer <s.hauer@pengutronix.de>
38. *                      Port to 2.6 kernel
39. *
40. *   24-Sep-2004   Ben Dooks <ben@simtec.co.uk>
41. *    Cleanup of code to remove ifdefs
42. *    Allowed platform device data to influence access width
43. *    Reformatting areas of code
44. *
45. *        17-Mar-2005   Sascha Hauer <s.hauer@pengutronix.de>
46. *                      * removed 2.4 style module parameters
47. *                      * removed removed unused stat counter and fixed
48. *                        net_device_stats
49. *                      * introduced tx_timeout function
50. *                      * reworked locking
51. *
52. *   01-Jul-2005   Ben Dooks <ben@simtec.co.uk>
53. *    * fixed spinlock call without pointer
54. *    * ensure spinlock is initialised
55. */
56. #include <linux/module.h>
57. #include <linux/ioport.h>
58. #include <linux/netdevice.h>
59. #include <linux/etherdevice.h>
60. #include <linux/init.h>
61. #include <linux/skbuff.h>
62. #include <linux/spinlock.h>
63. #include <linux/crc32.h>
64. #include <linux/mii.h>
65. #include <linux/dm9000.h>
66. #include <linux/delay.h>
67. #include <linux/platform_device.h>
69. #include <asm/delay.h>
70. #include <asm/irq.h>
71. #include <asm/io.h>
73. #include "dm9000.h"
75. /* Board/System/Debug information/definition ---------------- */
77. #define DM9000_PHY   0x40 /* PHY address 0x01 */
79. #define CARDNAME "dm9000"
80. #define PFX CARDNAME ": "
82. #define DM9000_TIMER_WUT jiffies+(HZ*2) /* timer wakeup time : 2 second */
84. #define DM9000_DEBUG 0
86. #if DM9000_DEBUG > 2
87. #define PRINTK3(args...) printk(CARDNAME ": " args)
88. #else
89. #define PRINTK3(args...) do { } while(0)
90. #endif
92. #if DM9000_DEBUG > 1
93. #define PRINTK2(args...) printk(CARDNAME ": " args)
94. #else
95. #define PRINTK2(args...) do { } while(0)
96. #endif
98. #if DM9000_DEBUG > 0
99. #define PRINTK1(args...) printk(CARDNAME ": " args)
100. #define PRINTK(args...)   printk(CARDNAME ": " args)
101. #else
102. #define PRINTK1(args...) do { } while(0)
103. #define PRINTK(args...)   printk(KERN_DEBUG args)
104. #endif
106. /*
107. * Transmit timeout, default 5 seconds.
108. */
109. static int watchdog = 5000;
110. module_param(watchdog, int, 0400);
111. MODULE_PARM_DESC(watchdog, "transmit timeout in milliseconds");
113. /*DM9000 含有16K SRAM作为FIFO buffer，3K用于transmitt,13k用于receive*/
115. /* Structure/enum declaration ------------------------------- */
116. typedef struct board_info {
117. /*命令地址寄存器地址*/
118. void __iomem *io_addr; /* Register I/O base address */
119. /*数据寄存器地址*/
120. void __iomem *io_data; /* Data I/O address */
121. u16 irq;   /* IRQ */
123. u16 tx_pkt_cnt;
124. u16 queue_pkt_len;
125. u16 queue_start_addr;
126. u16 dbug_cnt;
127. u8 io_mode;   /* 0:word, 2:byte */
128. u8 phy_addr;
130. void (*inblk)(void __iomem *port, void *data, int length);
131. void (*outblk)(void __iomem *port, void *data, int length);
132. void (*dumpblk)(void __iomem *port, int length);
134. struct resource *addr_res; /* resources found */
135. struct resource *data_res;
136. struct resource *addr_req;   /* resources requested */
137. struct resource *data_req;
138. struct resource *irq_res;
140. struct timer_list timer;
141. struct net_device_stats stats;
142. unsigned char srom[128];    /*网卡上EERPOM的内容*/
143. spinlock_t lock;
145. struct mii_if_info mii; /*调试可能会用到*/
146. u32 msg_enable;
147. } board_info_t;
149. /* function declaration ------------------------------------- */
150. static int dm9000_probe(struct platform_device *);
151. static int dm9000_open(struct net_device *);
152. static int dm9000_start_xmit(struct sk_buff *, struct net_device *);
153. static int dm9000_stop(struct net_device *);
156. static void dm9000_timer(unsigned long);
157. static void dm9000_init_dm9000(struct net_device *);
159. static struct net_device_stats *dm9000_get_stats(struct net_device *);
161. static irqreturn_t dm9000_interrupt(int, void *);
163. static int dm9000_phy_read(struct net_device *dev, int phyaddr_unsused, int reg);
164. static void dm9000_phy_write(struct net_device *dev, int phyaddr_unused, int reg,
165.       int value);
166. static u16 read_srom_word(board_info_t *, int);
167. static void dm9000_rx(struct net_device *);
168. static void dm9000_hash_table(struct net_device *);
170. //#define DM9000_PROGRAM_EEPROM
171. #ifdef DM9000_PROGRAM_EEPROM
172. static void program_eeprom(board_info_t * db);
173. #endif
174. /* DM9000 network board routine ---------------------------- */
176. static void
177. dm9000_reset(board_info_t * db)
178. {
179. PRINTK1("dm9000x: resetting/n");
180. /* RESET device */
181. /*指定DM9000当前的命令寄存器是NCR*/
182. writeb(DM9000_NCR, db->io_addr);
183. udelay(200);
184. /*向NCR寄存器写入复位标志，芯片复位*/
185. writeb(NCR_RST, db->io_data);
186. udelay(200);
187. }
189. /*
190. *   Read a byte from I/O port
191.      读取寄存器的值，reg表明寄存器的偏移量
192.      这里用宏名表示
193. */
195. static u8
196. ior(board_info_t * db, int reg)
197. {
198. writeb(reg, db->io_addr);
199. return readb(db->io_data);
200. }
202. /*
203. *   Write a byte to I/O port
204.     写寄存器的值，reg表明寄存器的偏移量
205.      这里用宏名表示，value是写入数据
206. */
208. static void
209. iow(board_info_t * db, int reg, int value)
210. {
211. writeb(reg, db->io_addr);
212. writeb(value, db->io_data);
213. }
215. /* routines for sending block to chip */
216. /*类似于内存拷贝
217. 简单的理解为memcpy(reg,data,count)
218. count是以字节为单位的！
219. */
220. static void dm9000_outblk_8bit(void __iomem *reg, void *data, int count)
221. {
222. writesb(reg, data, count);
223. }
225. static void dm9000_outblk_16bit(void __iomem *reg, void *data, int count)
226. {
227. writesw(reg, data, (count+1) >> 1);
228. }
230. static void dm9000_outblk_32bit(void __iomem *reg, void *data, int count)
231. {
232. writesl(reg, data, (count+3) >> 2);
233. }
235. /* input block from chip to memory */
236. /*类似于内存拷贝
237. 简单的理解为memcpy(data,reg,count)
238. count是以字节为单位的！
239. */
240. static void dm9000_inblk_8bit(void __iomem *reg, void *data, int count)
241. {
242. readsb(reg, data, count);
243. }
246. static void dm9000_inblk_16bit(void __iomem *reg, void *data, int count)
247. {
248. readsw(reg, data, (count+1) >> 1);
249. }
251. static void dm9000_inblk_32bit(void __iomem *reg, void *data, int count)
252. {
253. readsl(reg, data, (count+3) >> 2);
254. }
256. /* dump block from chip to null */
257. /*类似于内存清理，将reg指向的count清空。
258. 多用于设备的接收缓存区清空
259. count是以字节为单位的！
260. */
261. static void dm9000_dumpblk_8bit(void __iomem *reg, int count)
262. {
263. int i;
264. int tmp;
266. for (i = 0; i < count; i++)
267.    tmp = readb(reg);
268. }
270. static void dm9000_dumpblk_16bit(void __iomem *reg, int count)
271. {
272. int i;
273. int tmp;
275. count = (count + 1) >> 1;
277. for (i = 0; i < count; i++)
278.    tmp = readw(reg);
279. }
281. static void dm9000_dumpblk_32bit(void __iomem *reg, int count)
282. {
283. int i;
284. int tmp;
286. count = (count + 3) >> 2;
288. for (i = 0; i < count; i++)
289.    tmp = readl(reg);
290. }
292. /* dm9000_set_io
293. *
294. * select the specified set of io routines to use with the
295. * device
296. 根据芯片的外部总线带宽，指定对应的输入输出函数
297. */
299. static void dm9000_set_io(struct board_info *db, int byte_width)
300. {
301. /* use the size of the data resource to work out what IO
302. * routines we want to use
303. */
305. switch (byte_width) {
306. case 1:
307.    db->dumpblk = dm9000_dumpblk_8bit;
308.    db->outblk = dm9000_outblk_8bit;
309.    db->inblk   = dm9000_inblk_8bit;
310.    break;
312. case 2:
313.    db->dumpblk = dm9000_dumpblk_16bit;
314.    db->outblk = dm9000_outblk_16bit;
315.    db->inblk   = dm9000_inblk_16bit;
316.    break;
318. case 3:
319.    printk(KERN_ERR PFX ": 3 byte IO, falling back to 16bit/n");
320.    db->dumpblk = dm9000_dumpblk_16bit;
321.    db->outblk = dm9000_outblk_16bit;
322.    db->inblk   = dm9000_inblk_16bit;
323.    break;
325. case 4:
326. default:
327.    db->dumpblk = dm9000_dumpblk_32bit;
328.    db->outblk = dm9000_outblk_32bit;
329.    db->inblk   = dm9000_inblk_32bit;
330.    break;
331. }
332. }
334. /*超时处理函数*/
335. /* Our watchdog timed out. Called by the networking layer */
336. static void dm9000_timeout(struct net_device *dev)
337. {
338. board_info_t *db = (board_info_t *) dev->priv;
339. u8 reg_save;
340. unsigned long flags;
342. /* Save previous register address */
343. reg_save = readb(db->io_addr);
344. spin_lock_irqsave(&db->lock,flags);
345. /*停止发送报文 */
346. netif_stop_queue(dev);
347. /*复位DM9000芯片*/
348. dm9000_reset(db);
349. /*初始化DM9000芯片*/
350. dm9000_init_dm9000(dev);
351. /* We can accept TX packets again */
352. /*重启发送*/
353. dev->trans_start = jiffies;
354. netif_wake_queue(dev);
356. /* Restore previous register address */
357. /*io_addr的恢复，保证了芯片的配置和初始值一致*/
358. writeb(reg_save, db->io_addr);
359. spin_unlock_irqrestore(&db->lock,flags);
360. }
362. #ifdef CONFIG_NET_POLL_CONTROLLER
363. /*
364. *Used by netconsole
365. */
366. static void dm9000_poll_controller(struct net_device *dev)
367. {
368. disable_irq(dev->irq);
369. dm9000_interrupt(dev->irq,dev);
370. enable_irq(dev->irq);
371. }
372. #endif
374. /* dm9000_release_board
375. *
376. * release a board, and any mapped resources
377.     释放资源
378. */
380. static void
381. dm9000_release_board(struct platform_device *pdev, struct board_info *db)
382. {
383. if (db->data_res == NULL) {
384.    if (db->addr_res != NULL)
385.     release_mem_region((unsigned long)db->io_addr, 4);
386.    return;
387. }
389. /* unmap our resources */
391. iounmap(db->io_addr);
392. iounmap(db->io_data);
394. /* release the resources */
396. if (db->data_req != NULL) {
397.    release_resource(db->data_req);
398.    kfree(db->data_req);
399. }
401. if (db->addr_req != NULL) {
402.    release_resource(db->addr_req);
403.    kfree(db->addr_req);
404. }
405. }
407. #define res_size(_r) (((_r)->end - (_r)->start) + 1)
409. /*
410. * Search DM9000 board, allocate space and register it
411. */
412. static int
413. dm9000_probe(struct platform_device *pdev)
414. {
415. struct dm9000_plat_data *pdata = pdev->dev.platform_data;
416. struct board_info *db; /* Point a board information structure */
417. struct net_device *ndev;
418. unsigned long base;
419. int ret = 0;
420. int iosize;
421. int i;
422. u32 id_val;
424. /* 分配eth网卡资源，私有数据区保存board_info*/
425. ndev = alloc_etherdev(sizeof (struct board_info));
426. if (!ndev) {
427.    printk("%s: could not allocate device./n", CARDNAME);
428.    return -ENOMEM;
429. }
430. /*忽略*/
431. SET_MODULE_OWNER(ndev);
432. SET_NETDEV_DEV(ndev, &pdev->dev);
434. PRINTK2("dm9000_probe()");
436. /* setup board info structure 
437. bord info初始化为0 */
438. db = (struct board_info *) ndev->priv;
439. memset(db, 0, sizeof (*db));
440. /*初始化spinlock*/
441. spin_lock_init(&db->lock);
443. /*忽略*/
444. if (pdev->num_resources < 2) {
445.    ret = -ENODEV;
446.    goto out;
447. } else if (pdev->num_resources == 2) {
448.    base = pdev->resource[0].start;
450.    if (!request_mem_region(base, 4, ndev->name)) {
451.     ret = -EBUSY;
452.     goto out;
453.    }
455.    ndev->base_addr = base;
456.    ndev->irq = pdev->resource[1].start;
457.    db->io_addr = (void __iomem *)base;
458.    db->io_data = (void __iomem *)(base + 4);
460. } else {
461.    db->addr_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
462.    db->data_res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
463.    db->irq_res = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
465.    if (db->addr_res == NULL || db->data_res == NULL ||
466.       db->irq_res == NULL) {
467.     printk(KERN_ERR PFX "insufficient resources/n");
468.     ret = -ENOENT;
469.     goto out;
470.    }
472.    i = res_size(db->addr_res);
473.    db->addr_req = request_mem_region(db->addr_res->start, i,
474.         pdev->name);
476.    if (db->addr_req == NULL) {
477.     printk(KERN_ERR PFX "cannot claim address reg area/n");
478.     ret = -EIO;
479.     goto out;
480.    }
482.    db->io_addr = ioremap(db->addr_res->start, i);
484.    if (db->io_addr == NULL) {
485.     printk(KERN_ERR "failed to ioremap address reg/n");
486.     ret = -EINVAL;
487.     goto out;
488.    }
490.    iosize = res_size(db->data_res);
491.    db->data_req = request_mem_region(db->data_res->start, iosize,
492.         pdev->name);
494.    if (db->data_req == NULL) {
495.     printk(KERN_ERR PFX "cannot claim data reg area/n");
496.     ret = -EIO;
497.     goto out;
498.    }
500.    db->io_data = ioremap(db->data_res->start, iosize);
502.    if (db->io_data == NULL) {
503.     printk(KERN_ERR "failed to ioremap data reg/n");
504.     ret = -EINVAL;
505.     goto out;
506.    }
508.    /* fill in parameters for net-dev structure */
510.    ndev->base_addr = (unsigned long)db->io_addr;
511.    ndev->irq = db->irq_res->start;
513.    /* ensure at least we have a default set of IO routines */
514.    dm9000_set_io(db, iosize);
515. }
517. /* check to see if anything is being over-ridden */
518. if (pdata != NULL) {
519.    /* check to see if the driver wants to over-ride the
520.    * default IO width */
522.    if (pdata->flags & DM9000_PLATF_8BITONLY)
523.     dm9000_set_io(db, 1);
525.    if (pdata->flags & DM9000_PLATF_16BITONLY)
526.     dm9000_set_io(db, 2);
528.    if (pdata->flags & DM9000_PLATF_32BITONLY)
529.     dm9000_set_io(db, 4);
531.    /* check to see if there are any IO routine
532.    * over-rides */
534.    if (pdata->inblk != NULL)
535.     db->inblk = pdata->inblk;
537.    if (pdata->outblk != NULL)
538.     db->outblk = pdata->outblk;
540.    if (pdata->dumpblk != NULL)
541.     db->dumpblk = pdata->dumpblk;
542. }
543. /*根据board info信息，复位DM9000芯片*/
544. dm9000_reset(db);
546. /* try two times, DM9000 sometimes gets the first read wrong */
547. for (i = 0; i < 2; i++) {
548.    id_val = ior(db, DM9000_VIDL);
549.    id_val |= (u32)ior(db, DM9000_VIDH) << 8;
550.    id_val |= (u32)ior(db, DM9000_PIDL) << 16;
551.    id_val |= (u32)ior(db, DM9000_PIDH) << 24;
553.    if (id_val == DM9000_ID)
554.     break;
555.    printk("%s: read wrong id 0x%08x/n", CARDNAME, id_val);
556. }
557. /*芯片的ID获取失败，驱动不匹配*/
558. if (id_val != DM9000_ID) {
559.    printk("%s: wrong id: 0x%08x/n", CARDNAME, id_val);
560.    goto release;
561. }
563. /* from this point we assume that we have found a DM9000 */
565. /* driver system function 
566. 将DM9000作为以太网卡初始化内部数据结构*/
567. ether_setup(ndev);
569. ndev->open   = &dm9000_open;
570. ndev->hard_start_xmit    = &dm9000_start_xmit;
571. ndev->tx_timeout         = &dm9000_timeout;
572. ndev->watchdog_timeo = msecs_to_jiffies(watchdog); /*超时值*/
573. ndev->stop   = &dm9000_stop;
574. ndev->get_stats   = &dm9000_get_stats;
575. ndev->set_multicast_list = &dm9000_hash_table;
576. #ifdef CONFIG_NET_POLL_CONTROLLER
577. ndev->poll_controller = &dm9000_poll_controller;
578. #endif
580. #ifdef DM9000_PROGRAM_EEPROM
581. /*开发时，需要更新EERPOM的值*/
582. program_eeprom(db);
583. #endif
584. /*忽略*/
585. db->msg_enable       = NETIF_MSG_LINK;
586. db->mii.phy_id_mask = 0x1f;
587. db->mii.reg_num_mask = 0x1f;
588. db->mii.force_media = 0;
589. db->mii.full_duplex = 0;
590. db->mii.dev      = ndev;
591. db->mii.mdio_read    = dm9000_phy_read; /*DM9000可以提供MII，外接PHY*/
592. db->mii.mdio_write   = dm9000_phy_write;
594. /* 获取网卡上EEPROM9346的内容，走EERPOM接口 */
595. for (i = 0; i < 64; i++)
596.    /*采用16bit读取方式*/
597.    ((u16 *) db->srom)[i] = read_srom_word(db, i);
599. /* Set Node Address 
600.     EEPROM的前6个字节为MAC地址
601. */
602. for (i = 0; i < 6; i++)
603.    ndev->dev_addr[i] = db->srom[i];
604. /*验证获取的MAC地址是否合法*/
605. if (!is_valid_ether_addr(ndev->dev_addr)) {
606.    /* try reading from mac */
607.    /*不合法，重新从DM9000的内部寄存器获取MAC，不走EEPROM接口*/
608.    for (i = 0; i < 6; i++)
609.     ndev->dev_addr[i] = ior(db, i+DM9000_PAR);
610. }
611. /*两种方式都失败，提示用ifconfig,驱动没有对应接口！*/
612. if (!is_valid_ether_addr(ndev->dev_addr))
613.    printk("%s: Invalid ethernet MAC address. Please "
614.          "set using ifconfig/n", ndev->name);
616. platform_set_drvdata(pdev, ndev);
617. /*注册接口到系统中，状态默认down，不可用*/
618. ret = register_netdev(ndev);
620. if (ret == 0) {
621.    printk("%s: dm9000 at %p,%p IRQ %d MAC: ",
622.          ndev->name, db->io_addr, db->io_data, ndev->irq);
623.    for (i = 0; i < 5; i++)
624.     printk("%02x:", ndev->dev_addr[i]);
625.    printk("%02x/n", ndev->dev_addr[5]);
626. }
627. return 0;
629. release:
630. out:
631. printk("%s: not found (%d)./n", CARDNAME, ret);
632. /失败时，释放资源*/
633. dm9000_release_board(pdev, db);
634. free_netdev(ndev);
636. return ret;
637. }
639. /*
640. * Open the interface.
641. * The interface is opened whenever "ifconfig" actives it.
642.      当使用ifconfig激活该网络接口时调用
643. */
644. static int
645. dm9000_open(struct net_device *dev)
646. {
647. board_info_t *db = (board_info_t *) dev->priv;
649. PRINTK2("entering dm9000_open/n");
650. /*申请中断资源，注册中断函数*/
651. if (request_irq(dev->irq, &dm9000_interrupt, IRQF_SHARED, dev->name, dev))
652.    return -EAGAIN;
654. /* Initialize DM9000 board */
655. /*复位DM9000芯片*/
656. dm9000_reset(db);
657. /*配置DM9000芯片内寄存器，使其能工作*/
658. dm9000_init_dm9000(dev);
660. /* Init driver variable */
661. db->dbug_cnt = 0;
663. /* set and active a timer process */
664. init_timer(&db->timer);   /*初始化内核定时器*/
665. db->timer.expires = DM9000_TIMER_WUT; /*2s唤醒一次*/
666. db->timer.data     = (unsigned long) dev;
667. db->timer.function = &dm9000_timer; /*内核定时器溢出回调函数*/
668. add_timer(&db->timer); /*启动内核定时器*/
669. /*检查mii接口状态*/
670. mii_check_media(&db->mii, netif_msg_link(db), 1);
671. /*启动发送队列*/
672. netif_start_queue(dev);
674. return 0;
675. }
677. /*
678. * Initilize dm9000 board
679.    配置DM9000芯片内部寄存器，使其能工作
680. */
681. static void
682. dm9000_init_dm9000(struct net_device *dev)
683. {
684. board_info_t *db = (board_info_t *) dev->priv;
686. PRINTK1("entering %s/n",__FUNCTION__);
688. /* I/O mode
689. 检查当前芯片的总线带宽8bit，16bit，32bit
690. 芯片的总线带宽由硬件走线决定 */
691. db->io_mode = ior(db, DM9000_ISR) >> 6; /* ISR bit7:6 keeps I/O mode */
693. /* GPIO0 on pre-activate PHY 
694. 启动PHY*/
695. iow(db, DM9000_GPR, 0); /* REG_1F bit0 activate phyxcer */
696. iow(db, DM9000_GPCR, GPCR_GEP_CNTL); /* Let GPIO0 output */
697. iow(db, DM9000_GPR, 0); /* Enable PHY */
699. /* Program operating register */
700. /*清除发送配置选项*/
701. iow(db, DM9000_TCR, 0);         /* TX Polling clear */
702. iow(db, DM9000_BPTR, 0x3f); /* Less 3Kb, 200us */
703. iow(db, DM9000_FCR, 0xff); /* Flow Control */
704. iow(db, DM9000_SMCR, 0);        /* Special Mode */
705. /* clear TX status */
706. /*清除发送标志位*/
707. iow(db, DM9000_NSR, NSR_WAKEST | NSR_TX2END | NSR_TX1END);
708. /*清除中断标志位*/
709. iow(db, DM9000_ISR, ISR_CLR_STATUS); /* Clear interrupt status */
711. /* Set address filter table */
712. dm9000_hash_table(dev);
714. /* Activate DM9000 
715.    接收包大小不能超过1.5k,CRC错误的抛弃，使能接收*/
716. iow(db, DM9000_RCR, RCR_DIS_LONG | RCR_DIS_CRC | RCR_RXEN);
717. /* Enable TX/RX interrupt mask
718. 使用发送，接收中断。SRAM缓冲区指针自动回0 */
719. iow(db, DM9000_IMR, IMR_PAR | IMR_PTM | IMR_PRM);
721. /* Init Driver variable */
722. db->tx_pkt_cnt = 0;
723. db->queue_pkt_len = 0;
724. dev->trans_start = 0;
725. }
727. /*
728. * Hardware start transmission.
729. * Send a packet to media from the upper layer.
730. */
731. static int
732. dm9000_start_xmit(struct sk_buff *skb, struct net_device *dev)
733. {
734. board_info_t *db = (board_info_t *) dev->priv;
736. PRINTK3("dm9000_start_xmit/n");
738. if (db->tx_pkt_cnt > 1)
739.    return 1;
740. /*停止接收*/
741. netif_stop_queue(dev);
743. /* Disable all interrupts 
744. 关闭发送，接收中断*/
745. iow(db, DM9000_IMR, IMR_PAR);
747. /* Move data to DM9000 TX RAM */
748. writeb(DM9000_MWCMD, db->io_addr);
749. /*把skb的数据拷贝到DM9000的SRAM中*/
750. (db->outblk)(db->io_data, skb->data, skb->len);
751. /*统计值加上相应的长度*/
752. db->stats.tx_bytes += skb->len;
754. /* TX control: First packet immediately send, second packet queue */
755. if (db->tx_pkt_cnt == 0) {
757.    /* First Packet 
758.    发送的包增加*/
759.    db->tx_pkt_cnt++;
761.    /* Set TX length to DM9000 
762.    设定DM9000需要发送的包长度*/
763.    iow(db, DM9000_TXPLL, skb->len & 0xff);
764.    iow(db, DM9000_TXPLH, (skb->len >> 8) & 0xff);
766.    /* Issue TX polling command 
767.    设定发送请求，即启动发送*/
768.    iow(db, DM9000_TCR, TCR_TXREQ); /* Cleared after TX complete */
769.    /*启动时间*/
770.    dev->trans_start = jiffies; /* save the time stamp */
772. } else {
773.    /*第二个包发送，在tx_done中实现*/
774.    /* Second packet */
775.    db->tx_pkt_cnt++;
776.    db->queue_pkt_len = skb->len;
777. }
779. /* free this SKB
780. 发送完毕释放skb */
781. dev_kfree_skb(skb);
783. /* Re-enable resource check 
784. 第一个包发送完毕，即内存拷贝完毕，不是实际总线上的
785. 可以启动第二包拷贝到SRAM*/
786. if (db->tx_pkt_cnt == 1)
787.    netif_wake_queue(dev);
789. /* Re-enable interrupt 
790. 重新启用中断，这时DM9000若发送完成，会产生发送完毕中断*/
791. iow(db, DM9000_IMR, IMR_PAR | IMR_PTM | IMR_PRM);
793. return 0;
794. }
796. static void
797. dm9000_shutdown(struct net_device *dev)
798. {
799. board_info_t *db = (board_info_t *) dev->priv;
801. /* RESET device */
802. dm9000_phy_write(dev, 0, MII_BMCR, BMCR_RESET); /* PHY RESET */
803. /*关闭PHY*/
804. iow(db, DM9000_GPR, 0x01); /* Power-Down PHY */
805. /*屏蔽所有中断*/
806. iow(db, DM9000_IMR, IMR_PAR); /* Disable all interrupt */
807. /*禁用接收*/
808. iow(db, DM9000_RCR, 0x00); /* Disable RX */
809. }
811. /*
812. * Stop the interface.
813. * The interface is stopped when it is brought.
814. */
815. static int
816. dm9000_stop(struct net_device *ndev)
817. {
818. board_info_t *db = (board_info_t *) ndev->priv;
820. PRINTK1("entering %s/n",__FUNCTION__);
822. /* deleted timer 
823. 删除内核定时器*/
824. del_timer(&db->timer);
825. /*通知内核队列不可用*/
826. netif_stop_queue(ndev);
827. /*linkstat 状态断路*/
828. netif_carrier_off(ndev);
830. /* free interrupt 
831. 释放中断*/
832. free_irq(ndev->irq, ndev);
833. /*硬件上关闭芯片*/
834. dm9000_shutdown(ndev);
836. return 0;
837. }
839. /*
840. * DM9000 interrupt handler
841. * receive the packet to upper layer, free the transmitted packet
842. */
844. static void
845. dm9000_tx_done(struct net_device *dev, board_info_t * db)
846. {
847. int tx_status = ior(db, DM9000_NSR); /* Got TX status */
849. /*一个包已经发送完毕*/
850. if (tx_status & (NSR_TX2END | NSR_TX1END)) {
851.    /* One packet sent complete */
852.    db->tx_pkt_cnt--;
853.    db->stats.tx_packets++;
855.    /* Queue packet check & send 
856.    当前还有一个包未发送，且在缓冲区中，是第二个包*/
857.    if (db->tx_pkt_cnt > 0) {
858.     /*设定DM9000发送包的长度*/
859.     iow(db, DM9000_TXPLL, db->queue_pkt_len & 0xff);
860.     iow(db, DM9000_TXPLH, (db->queue_pkt_len >> 8) & 0xff);
861.     /*启动发送*/
862.     iow(db, DM9000_TCR, TCR_TXREQ);
863.     dev->trans_start = jiffies;
864.    }
865.    /*通知内核*/
866.    netif_wake_queue(dev);
867. }
868. }
870. static irqreturn_t
871. dm9000_interrupt(int irq, void *dev_id)
872. {
873. struct net_device *dev = dev_id;
874. board_info_t *db;
875. int int_status;
876. u8 reg_save;
878. PRINTK3("entering %s/n",__FUNCTION__);
880. if (!dev) {
881.    PRINTK1("dm9000_interrupt() without DEVICE arg/n");
882.    return IRQ_HANDLED;
883. }
885. /* A real interrupt coming */
886. db = (board_info_t *) dev->priv;
887. spin_lock(&db->lock);
889. /* Save previous register address */
890. /*保存寄存器值*/
891. reg_save = readb(db->io_addr);
893. /* Disable all interrupts 
894. 关闭所有中断*/
895. iow(db, DM9000_IMR, IMR_PAR);
897. /* Got DM9000 interrupt status */
898. int_status = ior(db, DM9000_ISR); /* Got ISR */
899. iow(db, DM9000_ISR, int_status); /* Clear ISR status */
901. /* Received the coming packet 
902. 接收包中断*/
903. if (int_status & ISR_PRS)
904.    dm9000_rx(dev);
906. /* Trnasmit Interrupt check 
907. 发送包中断*/
908. if (int_status & ISR_PTS)
909.    dm9000_tx_done(dev, db);
911. /* Re-enable interrupt mask */
912. iow(db, DM9000_IMR, IMR_PAR | IMR_PTM | IMR_PRM);
914. /* Restore previous register address */
915. writeb(reg_save, db->io_addr);
917. spin_unlock(&db->lock);
919. return IRQ_HANDLED;
920. }
922. /*
923. * Get statistics from driver.
924. 获取网卡接口统计信息
925. */
926. static struct net_device_stats *
927. dm9000_get_stats(struct net_device *dev)
928. {
929. board_info_t *db = (board_info_t *) dev->priv;
930. return &db->stats;
931. }
934. /*
935. * A periodic timer routine
936. * Dynamic media sense, allocated Rx buffer...
937. */
938. static void
939. dm9000_timer(unsigned long data)
940. {
941. struct net_device *dev = (struct net_device *) data;
942. board_info_t *db = (board_info_t *) dev->priv;
944. PRINTK3("dm9000_timer()/n");
945. /*检查mii接口*/
946. mii_check_media(&db->mii, netif_msg_link(db), 0);
948. /* Set timer again
949. 重新启动内核定时器，周期检查mii接口 */
950. db->timer.expires = DM9000_TIMER_WUT;
951. add_timer(&db->timer);
952. }
953. /*DM9000接收包头，芯片提供
954. 01，status，length low,length high*/
955. struct dm9000_rxhdr {
956. u16 RxStatus; 
957. u16 RxLen;
958. } __attribute__((__packed__));
960. /*
961. * Received a packet and pass to upper layer
962. */
963. static void
964. dm9000_rx(struct net_device *dev)
965. {
966. board_info_t *db = (board_info_t *) dev->priv;
967. struct dm9000_rxhdr rxhdr;
968. struct sk_buff *skb;
969. u8 rxbyte, *rdptr;
970. bool GoodPacket;
971. int RxLen;
973. /* Check packet ready or not */
974. do {
975.    ior(db, DM9000_MRCMDX); /* Dummy read */
977.    /* Get most updated data */
978.    rxbyte = readb(db->io_data);
980.    /* Status check: this byte must be 0 or 1 
981.    接收包最长为1536 */
982.    if (rxbyte > DM9000_PKT_RDY) {
983.     printk("status check failed: %d/n", rxbyte);
984.     iow(db, DM9000_RCR, 0x00); /* Stop Device */
985.     iow(db, DM9000_ISR, IMR_PAR); /* Stop INT request */
986.     return;
987.    }
989.    if (rxbyte != DM9000_PKT_RDY)
990.     return;
992.    /* A packet ready now & Get status/length */
993.    GoodPacket = true;
994.    writeb(DM9000_MRCMD, db->io_addr);
995.    /*获取接收数据包头，共4字节，参考DM9000手册*/
996.    (db->inblk)(db->io_data, &rxhdr, sizeof(rxhdr));
997.    /*查看包长*/
998.    RxLen = rxhdr.RxLen;
1000.    /* Packet Status check 
1001.    包长不能小于64字节*/
1002.    if (RxLen < 0x40) {
1003.     GoodPacket = false;
1004.     PRINTK1("Bad Packet received (runt)/n");
1005.    }
1006.    /*包长不能大于1536字节*/
1007.    if (RxLen > DM9000_PKT_MAX) {
1008.     PRINTK1("RST: RX Len:%x/n", RxLen);
1009.    }
1010.    /*接收的包有错误*/
1011.    if (rxhdr.RxStatus & 0xbf00) {
1012.     GoodPacket = false;
1013.     if (rxhdr.RxStatus & 0x100) {
1014.      PRINTK1("fifo error/n");
1015.      db->stats.rx_fifo_errors++;
1016.     }
1017.     if (rxhdr.RxStatus & 0x200) {
1018.      PRINTK1("crc error/n");
1019.      db->stats.rx_crc_errors++;
1020.     }
1021.     if (rxhdr.RxStatus & 0x8000) {
1022.      PRINTK1("length error/n");
1023.      db->stats.rx_length_errors++;
1024.     }
1025.    }
1027.    /* Move data from DM9000 
1028.    接收的包没有任何问题时*/
1029.    if (GoodPacket
1030.       && ((skb = dev_alloc_skb(RxLen + 4)) != NULL)) {
1031.       
1032.     skb_reserve(skb, 2);
1033.     rdptr = (u8 *) skb_put(skb, RxLen - 4);
1035.     /* Read received packet from RX SRAM */
1036.     /*数据从DM9000内存拷贝到skb*/
1037.     (db->inblk)(db->io_data, rdptr, RxLen);
1038.     /*更新接收字节数统计*/
1039.     db->stats.rx_bytes += RxLen;
1041.     /* Pass to upper layer */
1042.     skb->protocol = eth_type_trans(skb, dev);
1043.     /*通知上层有新的skb收到*/
1044.     netif_rx(skb);
1045.     /*接收包更新*/
1046.     db->stats.rx_packets++;
1048.    } else {
1049.     /* need to dump the packet's data */
1051.     (db->dumpblk)(db->io_data, RxLen);
1052.    }
1053. } while (rxbyte == DM9000_PKT_RDY);
1054. }
1056. /*
1057. * Read a word data from SROM
1058.     从EEPROM9346中读取数据 16bit
1059. */
1060. static u16
1061. read_srom_word(board_info_t * db, int offset)
1062. {
1063. iow(db, DM9000_EPAR, offset);
1064. iow(db, DM9000_EPCR, EPCR_ERPRR);
1065. mdelay(8);   /* according to the datasheet 200us should be enough,
1066.        but it doesn't work */
1067. iow(db, DM9000_EPCR, 0x0);
1068. return (ior(db, DM9000_EPDRL) + (ior(db, DM9000_EPDRH) << 8));
1069. }
1071. #ifdef DM9000_PROGRAM_EEPROM
1072. /*
1073. * Write a word data to SROM
1074. 向EEPROM 9346中写数据 16bit
1075. */
1076. static void
1077. write_srom_word(board_info_t * db, int offset, u16 val)
1078. {
1079. iow(db, DM9000_EPAR, offset);
1080. iow(db, DM9000_EPDRH, ((val >> 8) & 0xff));
1081. iow(db, DM9000_EPDRL, (val & 0xff));
1082. iow(db, DM9000_EPCR, EPCR_WEP | EPCR_ERPRW);
1083. mdelay(8);   /* same shit */
1084. iow(db, DM9000_EPCR, 0);
1085. }
1087. /*
1088. * Only for development:
1089. * Here we write static data to the eeprom in case
1090. * we don't have valid content on a new board
1091. */
1092. static void
1093. program_eeprom(board_info_t * db)
1094. {
1095. u16 eeprom[] = { 0x0c00, 0x007f, 0x1300, /* MAC Address */
1096.    0x0000,   /* Autoload: accept nothing */
1097.    0x0a46, 0x9000, /* Vendor / Product ID */
1098.    0x0000,   /* pin control */
1099.    0x0000,
1100. };    /* Wake-up mode control */
1101. int i;
1102. for (i = 0; i < 8; i++)
1103.    write_srom_word(db, i, eeprom[i]);
1104. }
1105. #endif
1108. /*
1109. * Calculate the CRC valude of the Rx packet
1110. * flag = 1 : return the reverse CRC (for the received packet CRC)
1111. *         0 : return the normal CRC (for Hash Table index)
1112.     计算接收包的crc值
1113. */
1115. static unsigned long
1116. cal_CRC(unsigned char *Data, unsigned int Len, u8 flag)
1117. {
1119.        u32 crc = ether_crc_le(Len, Data);
1121.        if (flag)
1122.                return ~crc;
1124.        return crc;
1125. }
1127. /*
1128. * Set DM9000 multicast address
1129. */
1130. static void
1131. dm9000_hash_table(struct net_device *dev)
1132. {
1133. board_info_t *db = (board_info_t *) dev->priv;
1134. struct dev_mc_list *mcptr = dev->mc_list;
1135. int mc_cnt = dev->mc_count;
1136. u32 hash_val;
1137. u16 i, oft, hash_table[4];
1138. unsigned long flags;
1140. PRINTK2("dm9000_hash_table()/n");
1142. spin_lock_irqsave(&db->lock,flags);
1144. for (i = 0, oft = 0x10; i < 6; i++, oft++)
1145.    iow(db, oft, dev->dev_addr[i]);
1147. /* Clear Hash Table */
1148. for (i = 0; i < 4; i++)
1149.    hash_table[i] = 0x0;
1151. /* broadcast address */
1152. hash_table[3] = 0x8000;
1154. /* the multicast address in Hash Table : 64 bits */
1155. for (i = 0; i < mc_cnt; i++, mcptr = mcptr->next) {
1156.    hash_val = cal_CRC((char *) mcptr->dmi_addr, 6, 0) & 0x3f;
1157.    hash_table[hash_val / 16] |= (u16) 1 << (hash_val % 16);
1158. }
1160. /* Write the hash table to MAC MD table */
1161. for (i = 0, oft = 0x16; i < 4; i++) {
1162.    iow(db, oft++, hash_table[i] & 0xff);
1163.    iow(db, oft++, (hash_table[i] >> 8) & 0xff);
1164. }
1166. spin_unlock_irqrestore(&db->lock,flags);
1167. }
1170. /*
1171. *   Read a word from phyxcer
1172.    从PHY读取数据16bit
1173. */
1174. static int
1175. dm9000_phy_read(struct net_device *dev, int phy_reg_unused, int reg)
1176. {
1177. board_info_t *db = (board_info_t *) dev->priv;
1178. unsigned long flags;
1179. unsigned int reg_save;
1180. int ret;
1182. spin_lock_irqsave(&db->lock,flags);
1184. /* Save previous register address */
1185. reg_save = readb(db->io_addr);
1187. /* Fill the phyxcer register into REG_0C */
1188. iow(db, DM9000_EPAR, DM9000_PHY | reg);
1190. iow(db, DM9000_EPCR, 0xc); /* Issue phyxcer read command */
1191. udelay(100);   /* Wait read complete */
1192. iow(db, DM9000_EPCR, 0x0); /* Clear phyxcer read command */
1194. /* The read data keeps on REG_0D & REG_0E */
1195. ret = (ior(db, DM9000_EPDRH) << 8) | ior(db, DM9000_EPDRL);
1197. /* restore the previous address */
1198. writeb(reg_save, db->io_addr);
1200. spin_unlock_irqrestore(&db->lock,flags);
1202. return ret;
1203. }
1205. /*
1206. *   Write a word to phyxcer
1207. 向PHY写入数据16bit
1208. */
1209. static void
1210. dm9000_phy_write(struct net_device *dev, int phyaddr_unused, int reg, int value)
1211. {
1212. board_info_t *db = (board_info_t *) dev->priv;
1213. unsigned long flags;
1214. unsigned long reg_save;
1216. spin_lock_irqsave(&db->lock,flags);
1218. /* Save previous register address */
1219. reg_save = readb(db->io_addr);
1221. /* Fill the phyxcer register into REG_0C */
1222. iow(db, DM9000_EPAR, DM9000_PHY | reg);
1224. /* Fill the written data into REG_0D & REG_0E */
1225. iow(db, DM9000_EPDRL, (value & 0xff));
1226. iow(db, DM9000_EPDRH, ((value >> 8) & 0xff));
1228. iow(db, DM9000_EPCR, 0xa); /* Issue phyxcer write command */
1229. udelay(500);   /* Wait write complete */
1230. iow(db, DM9000_EPCR, 0x0); /* Clear phyxcer write command */
1232. /* restore the previous address */
1233. writeb(reg_save, db->io_addr);
1235. spin_unlock_irqrestore(&db->lock,flags);
1236. }
1238. /*挂起网卡接口*/
1239. static int
1240. dm9000_drv_suspend(struct platform_device *dev, pm_message_t state)
1241. {
1242. struct net_device *ndev = platform_get_drvdata(dev);
1244. if (ndev) {
1245.    if (netif_running(ndev)) {
1246.     /*内核临时删除接口*/
1247.     netif_device_detach(ndev);
1248.     /*关闭设备*/
1249.     dm9000_shutdown(ndev);
1250.    }
1251. }
1252. return 0;
1253. }
1255. static int
1256. dm9000_drv_resume(struct platform_device *dev)
1257. {
1258. struct net_device *ndev = platform_get_drvdata(dev);
1259. board_info_t *db = (board_info_t *) ndev->priv;
1261. if (ndev) {
1263.    if (netif_running(ndev)) {
1264.     /*复位设备*/
1265.     dm9000_reset(db);
1266.     dm9000_init_dm9000(ndev);
1267.     /*恢复接口*/
1268.     netif_device_attach(ndev);
1269.    }
1270. }
1271. return 0;
1272. }
1274. static int
1275. dm9000_drv_remove(struct platform_device *pdev)
1276. {
1277. struct net_device *ndev = platform_get_drvdata(pdev);
1279. platform_set_drvdata(pdev, NULL);
1280. /*释放注册的网络接口*/
1281. unregister_netdev(ndev);
1282. dm9000_release_board(pdev, (board_info_t *) ndev->priv);
1283. /*释放资源*/
1284. free_netdev(ndev);   /* free device structure */
1286. PRINTK1("clean_module() exit/n");
1288. return 0;
1289. }
1291. static struct platform_driver dm9000_driver = {
1292. .driver = {
1293.    .name    = "dm9000",
1294.    .owner = THIS_MODULE,
1295. },
1296. .probe   = dm9000_probe,
1297. .remove = dm9000_drv_remove,
1298. .suspend = dm9000_drv_suspend,
1299. .resume = dm9000_drv_resume,
1300. };
1302. static int __init
1303. dm9000_init(void)
1304. {
1305. printk(KERN_INFO "%s Ethernet Driver/n", CARDNAME);
1307. return platform_driver_register(&dm9000_driver); /* search board and register */
1308. }
1310. static void __exit
1311. dm9000_cleanup(void)
1312. {
1313. platform_driver_unregister(&dm9000_driver);
1314. }
1316. module_init(dm9000_init);
1317. module_exit(dm9000_cleanup);
1319. MODULE_AUTHOR("Sascha Hauer, Ben Dooks");
1320. MODULE_DESCRIPTION("Davicom DM9000 network driver");
1321. MODULE_LICENSE("GPL");

 

附件：DM9000网卡芯片手册，大家可以对照寄存器查看

                         http://blog.21ic.com/uploadfile-/2007-8/85766303.pdf