Linux 内核ethtool框架新增刷网卡firmware功能


现在的网卡，尤其是智能网卡、高速网卡，硬件性能越来越强大，承载的功能也越来越多。开发者对网卡内部功能的增加或修改，对已知bug的修正都离不开对网卡Firmware的更新。Linux操作系统对网卡 Firmware的更新提供了一整套机制，允许网卡驱动在必要时可以动态加载新的网卡Firmware。最新的内核中，动态加载Firmware的功能被加入到了Ethtool框架中，使得在用户空间加载网卡Firmware的操作标准化。


网卡 Firmware 的更新

 

针对网卡 Firmware 更新的必要性无需多言，目前的很多无线网卡 ( 比如 intel 系列的无线网卡 ) 、智能网卡 ( 比如 NetXen 的 10G 网卡 ) 都需要不停的更新 Firmware ，不同厂商在实现方式上，也都大同小异：一般都是在驱动初始化过程中，调用 linux 内核提供的一系列 Firmware 函数进行更新。这些函数包括：

int request_firmware(struct firmware **fw, char *name ,struct device *device);

void release_firmware(struct firmware *fw);

驱动程序本身知道自己的 Firmware 文件的名字 name ，所以只要将 Firmware 文件放到标准目录 /lib/firmware/ 下，驱动程序调用 request_firmware 时可以仅凭 name 就能读取到该文件，然后将其刷入网卡的 flash 中。需要注意的， request_firmware 的正常运作需要用户空间 udev 的支持。

 

 

Ethtool 框架

 

Ethtool 框架是 linux 内核提供的对网络设备进行查询和管理的标准接口， linux 下几乎所有的网卡驱动都提供了对 ethtool 功能的支持。随着内核的开发， ethtool 框架的功能正在越来越完善。即将发布的 2.6.32 版内核，加入了对于更新网卡 Firmware 的接口支持。本文就是对这个新功能的剖析。

 

Ethtool 框架包含内核空间和用户空间两部分：用户空间的部分负责将 ethtool 命令发送到内核，并接收命令的执行结果；内核空间的部分负责将用户空间的命令递交给网卡驱动，并把执行结果传回用户空间。

 

可执行档 ethtool 是用户空间用于操作内核 ethtool 框架的事实标准。 Ethtool 工具最新版本是在 2007 年 7 月发布的 ethtool-6.tar.gz ，地址 http://sourceforge.net/projects/gkernel/ 。

 

 

内核的改变

 

针对刷网卡 Firmware 新功能的增加，内核中的改变涉及到 3 部分：

Ethtool 框架中的头文件；

Ethtool 框架中的实现文件；

网卡驱动中是否实现对刷 Firmware 的支持。

 

(1) src/include/linux/ethtool.h 中的改动

 

新加 ethtool 命令字和参数定义：

#define       ETHTOOL_FLASHDEV     0x00000033 /* Flash firmware to device */

#define ETHTOOL_FLASH_MAX_FILENAME   128

enum ethtool_flash_op_type {

         ETHTOOL_FLASH_ALL_REGIONS   = 0,

};

/* for passing firmware flashing related parameters */

struct ethtool_flash {

         __u32         cmd;  // ETHTOOL_FLASHDEV

         __u32         region; // 需要将 Firmware 映像文件的哪部分刷入网卡 flash 中？

         char   data[ETHTOOL_FLASH_MAX_FILENAME]; // 这个参数其实就是个不带路径的 Firmware 文件名

};

 

在著名的 ethtool_ops 结构中新加入一个函数指针 flash_device ，这个函数需要由网卡驱动程序来提供：

struct ethtool_ops {

         ......

         int     (*flash_device )(struct net_device *, struct ethtool_flash *);

};

 

(2) src/net/core/ethtool.c 中的改动

 

在 dev_ethtool 中加入对于 ETHTOOL_FLASHDEV 命令字的分支：

int dev_ethtool(struct net *net, struct ifreq *ifr)

{       ……

         switch(ethcmd) {

         ……

         case ETHTOOL_FLASHDEV :

                   rc = ethtool_flash_device (dev, useraddr);

                   break;

         return rc;

}

 

把刷 Firmware 的重任交给网卡驱动去做：

static int ethtool_flash_device (struct net_device *dev, char __user *useraddr)

{

         struct ethtool_flash efl;

 

         if (copy_from_user(&efl, useraddr, sizeof(efl)))

                   return -EFAULT;

 

         if (!dev->ethtool_ops->flash_device) // 驱动是否支持？

                   return -EOPNOTSUPP;

 

         return dev->ethtool_ops->flash_device(dev, &efl) ; // 驱动支持的话，将剩下的操作交给驱动来完成

}

 

(3) 网卡驱动支持

 

网卡驱动实现该接口没啥难度，还是利用 request_firmware 读取固件内容，然后利用自身接口将 Firmware 写入 flash 中。

 

目前绝大多数网卡驱动尚未意识到 ethtool 的变化。我只发现 benet 驱动程序支持新接口，路径 src/drivers/net/benet/* ，是个 10G 网卡“ ServerEngines' 10Gbps NIC - BladeEngine 2” ：

src/drivers/net/benet/be_ethtool.c, line 369

const struct ethtool_ops be_ethtool_ops = {

         ……

         .get_ethtool_stats = be_get_ethtool_stats,

         .flash_device = be_do_flash,

};

 

 

对 ethtool 的补丁

 

Ethtool 官方尚未及时跟进，有好事者已经制作好补丁，加入参数 -f 进行支持。在实现上，其功能主要是将 Firmware 文件名字传入到网卡驱动中，并引发对 ethtool_ops->flash_device 的调用。语法： 

ethtool -f <if_name> <fw_name>

在执行命令前，需要将 fw_name 放在 /lib/firmware/ 目录下。

 

以下是 ethtool 补丁：

diff --git a/ethtool-copy.h b/ethtool-copy.h

index 3ca4e2c..a7d11fb 100644

--- a/ethtool-copy.h

+++ b/ethtool-copy.h

@@ -272,6 +272,21 @@   struct ethtool_perm_addr {

       __u8       data[0];

  };

 

+#define ETHTOOL_FLASH_MAX_FILENAME 128

+#define ETHTOOL_FLASH_OP_TYPE_SIZE      32

+enum ethtool_flash_op_type {

+       ETHTOOL_FLASH_ALL             = 0,

+       ETHTOOL_FLASH_PHY,

+       ETHTOOL_FLASH_REDBOOT,

+};

+

+/* for passing firmware flashing related parameters */

+struct ethtool_flash {

+       __u32         cmd;

+       __u32         op_type;

+       char   data[256];

+};

+

  /* boolean flags controlling per-interface behavior characteristics.

  * When reading, the flag indicates whether or not a certain behavior

  * is enabled/present.  When writing, the flag indicates whether

@@ -338,6 +353,7 @@   struct ethtool_rxnfc {

  #define  ETHTOOL_SRXFH              0x0000002a /* Set RX flow hash configuration */

  #define ETHTOOL_GGRO         0x0000002b /* Get GRO enable (ethtool_value) */

  #define ETHTOOL_SGRO         0x0000002c /* Set GRO enable (ethtool_value) */

+#define ETHTOOL_FLASHDEV         0x00000033 /* Flash firmware to device */

 

  /* compatibility with older code */

  #define SPARC_ETH_GSET              ETHTOOL_GSET

diff --git a/ethtool.c b/ethtool.c

index 0110682..d73ddc4 100644

--- a/ethtool.c

+++ b/ethtool.c

@@ -77,6 +77,7 @@   static char *unparse_rxfhashopts(u64 opts);

  static int dump_rxfhash(int fhash, u64 val);

  static int do_srxclass(int fd, struct ifreq *ifr);

  static int do_grxclass(int fd, struct ifreq *ifr);

+static int do_flash(int fd, struct ifreq *ifr);

  static int send_ioctl(int fd, struct ifreq *ifr);

 

  static enum {

@@ -101,6 +102,7 @@   static enum {

       MODE_GSTATS,

       MODE_GNFC,

       MODE_SNFC,

+       MODE_FLASHDEV,

  } mode = MODE_GSET;

 

  static struct option {

@@ -192,6 +194,9 @@   static struct option {

              "classification options",

              "             [ rx-flow-hash tcp4|udp4|ah4|sctp4|"

              "tcp6|udp6|ah6|sctp6 p|m|v|t|s|d|f|n|r... ]/n" },

+    { "-f", "--flash", MODE_FLASHDEV, "FILENAME " "Flash firmware image "

+                "from the specified file to device",

+                "                 [ all|redboot|phy ]/n" },

     { "-h", "--help", MODE_HELP, "Show this help" },

     {}

  };

@@ -304,6 +309,9 @@   static int rx_fhash_get = 0;

  static int rx_fhash_set = 0;

  static u32 rx_fhash_val = 0;

  static int rx_fhash_changed = 0;

+static char flash_file[ETHTOOL_FLASH_MAX_FILENAME];

+static int flash = -1;

+static int flash_op = -1;

  static enum {

       ONLINE=0,

       OFFLINE,

@@ -496,7 +504,8 @@   static void parse_cmdline(int argc, char **argp)

                         (mode == MODE_GSTATS) ||

                         (mode == MODE_GNFC) ||

                         (mode == MODE_SNFC) ||

-                                (mode == MODE_PHYS_ID)) {

+                              (mode == MODE_PHYS_ID) ||

+                              (mode == MODE_FLASHDEV)) {

                            devname = argp[i];

                            break;

                     }

@@ -516,6 +525,10 @@   static void parse_cmdline(int argc, char **argp)

                            if (phys_id_time < 0)

                                   show_usage(1);

                            break;

+                          } else if (mode == MODE_FLASHDEV) {

+                                   sprintf(flash_file, "%s", argp[i]);

+                                   flash = 1;

+                                   break;

                     }

                     /* fallthrough */

              default:

@@ -590,6 +603,17 @@   static void parse_cmdline(int argc, char **argp)

                                   show_usage(1);

                            break;

                     }

+                          if (mode == MODE_FLASHDEV) {

+                                   if (!strcmp(argp[i], "redboot"))

+                                            flash_op = ETHTOOL_FLASH_REDBOOT;

+                                   else if (!strcmp(argp[i], "phy"))

+                                            flash_op = ETHTOOL_FLASH_PHY;

+                                   else if (!strcmp(argp[i], "all"))

+                                            flash_op = ETHTOOL_FLASH_ALL;

+                                   else

+                                            show_usage(1);

+                                   break;

+                          }

                     if (mode == MODE_SNFC) {

                            if (!strcmp(argp[i], "rx-flow-hash")) {

                                   i += 1;

@@ -1504,6 +1528,8 @@   static int doit(void)

              return do_grxclass(fd, &ifr);

       } else if (mode == MODE_SNFC) {

              return do_srxclass(fd, &ifr);

+       } else if (mode == MODE_FLASHDEV) {

+                return do_flash(fd, &ifr);

       }

 

       return 69;

@@ -2398,6 +2424,49 @@   static int do_grxclass(int fd, struct ifreq *ifr)

       return 0;

  }

 

+static int do_flash(int fd, struct ifreq *ifr)

+{

+       struct ethtool_flash efl;

+       int err;

+       char path[ETHTOOL_FLASH_MAX_FILENAME * 2] = "/lib/firmware/";

+       FILE *f;

+

+       if (flash < 0) {

+                fprintf(stdout, "Missing filename argument/n");

+                show_usage(1);

+                return -EPERM;

+       }

+

+       strcat(path, flash_file);

+

+       if (strlen(flash_file) > ETHTOOL_FLASH_MAX_FILENAME) {

+                fprintf(stdout, "Filename too long/n");

+                return -EINVAL;

+       }

+

+       f = fopen(path, "r");

+       if (!f) {

+                perror(path);

+                return -ENOENT;

+       }

+       fclose(f);

+

+       efl.cmd = ETHTOOL_FLASHDEV;

+       sprintf(efl.data, "%s", flash_file);

+

+       if (flash_op < 0)

+                efl.op_type = ETHTOOL_FLASH_ALL;

+       else

+                efl.op_type = flash_op;

+

+       ifr->ifr_data = (caddr_t)&efl;

+       err = send_ioctl(fd, ifr);

+       if (err < 0)

+                perror("Flashing failed");

+

+       return err;

+}

+

  static int send_ioctl(int fd, struct ifreq *ifr)

  {

       return ioctl(fd, SIOCETHTOOL, ifr);

 

 

 

小结

 

新接口如果推广开来广泛应用的话，那么在 linux 下刷网卡 Firmware 将会标准化，不再需要厂家单独提供刷 FLASH 的工具了。

相关内容