現在的網卡，尤其是智能網卡、高速網卡，硬件性能越來越強大，承載的功能也越來越多。開發者對網卡內部功能的增加或修改，對已知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 的工具了。
