Add get/set_module_eeprom_by_page ethtool ops to netdevsim, enabling
testing of kernel features that depend on module EEPROM access (e.g.
CMIS loopback) without real hardware.
The EEPROM is backed by a 256-page x 128-byte array exposed as binary
debugfs files under ports/<N>/ethtool/module/pages/{0..255}. Offsets
0-127 map to page 0 (lower memory), 128-255 to the requested page's
upper memory, following the CMIS layout. Error injection via get_err
and set_err follows the existing netdevsim pattern.
Signed-off-by: Björn Töpel <bjorn@kernel.org>
---
drivers/net/netdevsim/ethtool.c | 83 +++++++++++++++++++++++++++++++
drivers/net/netdevsim/netdevsim.h | 11 ++++
2 files changed, 94 insertions(+)
diff --git a/drivers/net/netdevsim/ethtool.c b/drivers/net/netdevsim/ethtool.c
index 84bc025885f7..7ef96a747643 100644
--- a/drivers/net/netdevsim/ethtool.c
+++ b/drivers/net/netdevsim/ethtool.c
@@ -247,6 +247,68 @@ static int nsim_set_loopback(struct net_device *dev,
return 1;
}
+static u8 *nsim_module_eeprom_ptr(struct netdevsim *ns,
+ const struct ethtool_module_eeprom *page_data,
+ u32 *len)
+{
+ u32 offset;
+ u8 page;
+
+ if (page_data->offset < NSIM_MODULE_EEPROM_PAGE_LEN) {
+ page = 0;
+ offset = page_data->offset;
+ } else {
+ page = page_data->page;
+ offset = page_data->offset - NSIM_MODULE_EEPROM_PAGE_LEN;
+ }
+
+ *len = min_t(u32, page_data->length,
+ NSIM_MODULE_EEPROM_PAGE_LEN - offset);
+ return ns->ethtool.module.pages[page] + offset;
+}
+
+static int
+nsim_get_module_eeprom_by_page(struct net_device *dev,
+ const struct ethtool_module_eeprom *page_data,
+ struct netlink_ext_ack *extack)
+{
+ struct netdevsim *ns = netdev_priv(dev);
+ u32 len;
+ u8 *ptr;
+
+ if (ns->ethtool.module.get_err)
+ return -ns->ethtool.module.get_err;
+
+ ptr = nsim_module_eeprom_ptr(ns, page_data, &len);
+ if (!ptr)
+ return -EINVAL;
+
+ memcpy(page_data->data, ptr, len);
+
+ return len;
+}
+
+static int
+nsim_set_module_eeprom_by_page(struct net_device *dev,
+ const struct ethtool_module_eeprom *page_data,
+ struct netlink_ext_ack *extack)
+{
+ struct netdevsim *ns = netdev_priv(dev);
+ u32 len;
+ u8 *ptr;
+
+ if (ns->ethtool.module.set_err)
+ return -ns->ethtool.module.set_err;
+
+ ptr = nsim_module_eeprom_ptr(ns, page_data, &len);
+ if (!ptr)
+ return -EINVAL;
+
+ memcpy(ptr, page_data->data, len);
+
+ return 0;
+}
+
static int nsim_get_ts_info(struct net_device *dev,
struct kernel_ethtool_ts_info *info)
{
@@ -274,6 +336,8 @@ static const struct ethtool_ops nsim_ethtool_ops = {
.set_fecparam = nsim_set_fecparam,
.get_fec_stats = nsim_get_fec_stats,
.get_ts_info = nsim_get_ts_info,
+ .get_module_eeprom_by_page = nsim_get_module_eeprom_by_page,
+ .set_module_eeprom_by_page = nsim_set_module_eeprom_by_page,
.get_loopback = nsim_get_loopback,
.get_loopback_by_index = nsim_get_loopback_by_index,
.set_loopback = nsim_set_loopback,
@@ -292,6 +356,7 @@ static void nsim_ethtool_ring_init(struct netdevsim *ns)
void nsim_ethtool_init(struct netdevsim *ns)
{
struct dentry *ethtool, *dir;
+ int i;
ns->netdev->ethtool_ops = &nsim_ethtool_ops;
@@ -326,6 +391,24 @@ void nsim_ethtool_init(struct netdevsim *ns)
debugfs_create_u32("tx_max_pending", 0600, dir,
&ns->ethtool.ring.tx_max_pending);
+ dir = debugfs_create_dir("module", ethtool);
+ debugfs_create_u32("get_err", 0600, dir, &ns->ethtool.module.get_err);
+ debugfs_create_u32("set_err", 0600, dir, &ns->ethtool.module.set_err);
+
+ dir = debugfs_create_dir("pages", dir);
+ for (i = 0; i < NSIM_MODULE_EEPROM_PAGES; i++) {
+ char name[8];
+
+ ns->ethtool.module.page_blobs[i].data =
+ ns->ethtool.module.pages[i];
+ ns->ethtool.module.page_blobs[i].size =
+ NSIM_MODULE_EEPROM_PAGE_LEN;
+
+ snprintf(name, sizeof(name), "%u", i);
+ debugfs_create_blob(name, 0600, dir,
+ &ns->ethtool.module.page_blobs[i]);
+ }
+
ns->ethtool.mac_lb.supported = ETHTOOL_LOOPBACK_DIRECTION_NEAR_END |
ETHTOOL_LOOPBACK_DIRECTION_FAR_END;
diff --git a/drivers/net/netdevsim/netdevsim.h b/drivers/net/netdevsim/netdevsim.h
index 2e322b9410d2..f6b2063d41c9 100644
--- a/drivers/net/netdevsim/netdevsim.h
+++ b/drivers/net/netdevsim/netdevsim.h
@@ -82,6 +82,16 @@ struct nsim_ethtool_pauseparam {
bool report_stats_tx;
};
+#define NSIM_MODULE_EEPROM_PAGES 256
+#define NSIM_MODULE_EEPROM_PAGE_LEN 128
+
+struct nsim_ethtool_module {
+ u32 get_err;
+ u32 set_err;
+ u8 pages[NSIM_MODULE_EEPROM_PAGES][NSIM_MODULE_EEPROM_PAGE_LEN];
+ struct debugfs_blob_wrapper page_blobs[NSIM_MODULE_EEPROM_PAGES];
+};
+
struct nsim_ethtool {
u32 get_err;
u32 set_err;
@@ -94,6 +104,7 @@ struct nsim_ethtool {
u32 supported;
u32 direction;
} mac_lb;
+ struct nsim_ethtool_module module;
};
struct nsim_rq {
--
2.53.0
This is an AI-generated review of your patch. The human sending this
email has considered the AI review valid, or at least plausible.
For local reproduction steps see https://netdev-ai.bots.linux.dev/ai-local.html
---
netdevsim: Add module EEPROM simulation via debugfs
This patch adds get/set_module_eeprom_by_page ethtool ops to netdevsim
for testing kernel features that depend on module EEPROM access. The
EEPROM is backed by a 256-page x 128-byte array exposed via debugfs.
> diff --git a/drivers/net/netdevsim/ethtool.c b/drivers/net/netdevsim/ethtool.c
> index 84bc025885f7..7ef96a747643 100644
> --- a/drivers/net/netdevsim/ethtool.c
> +++ b/drivers/net/netdevsim/ethtool.c
> @@ -247,6 +247,68 @@ static int nsim_set_loopback(struct net_device *dev,
> return 1;
> }
>
> +static u8 *nsim_module_eeprom_ptr(struct netdevsim *ns,
> + const struct ethtool_module_eeprom *page_data,
> + u32 *len)
> +{
> + u32 offset;
> + u8 page;
> +
> + if (page_data->offset < NSIM_MODULE_EEPROM_PAGE_LEN) {
> + page = 0;
> + offset = page_data->offset;
> + } else {
> + page = page_data->page;
^^^^
Does this need bounds checking? The page_data->page value comes from userspace
via ethtool and is used directly as an array index at the return statement
below. The module.pages array is defined as:
u8 pages[NSIM_MODULE_EEPROM_PAGES][NSIM_MODULE_EEPROM_PAGE_LEN]
where NSIM_MODULE_EEPROM_PAGES is 256. A userspace caller could provide a page
number >= 256, leading to an out-of-bounds access:
return ns->ethtool.module.pages[page] + offset;
This can result in reading or writing (via nsim_set_module_eeprom_by_page)
adjacent kernel memory.
> + offset = page_data->offset - NSIM_MODULE_EEPROM_PAGE_LEN;
> + }
> +
> + *len = min_t(u32, page_data->length,
> + NSIM_MODULE_EEPROM_PAGE_LEN - offset);
^^^^^^
Can offset exceed NSIM_MODULE_EEPROM_PAGE_LEN here? When page_data->offset >=
128, the code calculates:
offset = page_data->offset - NSIM_MODULE_EEPROM_PAGE_LEN
If page_data->offset is large (e.g., 300), the resulting offset would be 172.
At the min_t calculation:
NSIM_MODULE_EEPROM_PAGE_LEN - offset = 128 - 172 = -44
This underflows when cast to u32, becoming a large unsigned value. The return
statement then accesses:
ns->ethtool.module.pages[page] + offset
where offset can be > 128, reading past the page boundary. Each page is only
NSIM_MODULE_EEPROM_PAGE_LEN (128) bytes, but offset isn't validated to be
within this range.
> + return ns->ethtool.module.pages[page] + offset;
> +}
> +
> +static int
> +nsim_get_module_eeprom_by_page(struct net_device *dev,
> + const struct ethtool_module_eeprom *page_data,
> + struct netlink_ext_ack *extack)
> +{
> + struct netdevsim *ns = netdev_priv(dev);
> + u32 len;
> + u8 *ptr;
> +
> + if (ns->ethtool.module.get_err)
> + return -ns->ethtool.module.get_err;
> +
> + ptr = nsim_module_eeprom_ptr(ns, page_data, &len);
> + if (!ptr)
> + return -EINVAL;
> +
> + memcpy(page_data->data, ptr, len);
> +
> + return len;
> +}
> +
> +static int
> +nsim_set_module_eeprom_by_page(struct net_device *dev,
> + const struct ethtool_module_eeprom *page_data,
> + struct netlink_ext_ack *extack)
> +{
> + struct netdevsim *ns = netdev_priv(dev);
> + u32 len;
> + u8 *ptr;
> +
> + if (ns->ethtool.module.set_err)
> + return -ns->ethtool.module.set_err;
> +
> + ptr = nsim_module_eeprom_ptr(ns, page_data, &len);
> + if (!ptr)
> + return -EINVAL;
> +
> + memcpy(ptr, page_data->data, len);
> +
> + return 0;
> +}
[ ... ]
> diff --git a/drivers/net/netdevsim/netdevsim.h b/drivers/net/netdevsim/netdevsim.h
> index 2e322b9410d2..f6b2063d41c9 100644
> --- a/drivers/net/netdevsim/netdevsim.h
> +++ b/drivers/net/netdevsim/netdevsim.h
> @@ -82,6 +82,16 @@ struct nsim_ethtool_pauseparam {
> bool report_stats_tx;
> };
>
> +#define NSIM_MODULE_EEPROM_PAGES 256
> +#define NSIM_MODULE_EEPROM_PAGE_LEN 128
> +
> +struct nsim_ethtool_module {
> + u32 get_err;
> + u32 set_err;
> + u8 pages[NSIM_MODULE_EEPROM_PAGES][NSIM_MODULE_EEPROM_PAGE_LEN];
> + struct debugfs_blob_wrapper page_blobs[NSIM_MODULE_EEPROM_PAGES];
> +};
[ ... ]
© 2016 - 2026 Red Hat, Inc.