-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ethtool: Allow network drivers to dump arbitrary EEPROM data
Define get_module_eeprom_by_page() ethtool callback and implement netlink infrastructure. get_module_eeprom_by_page() allows network drivers to dump a part of module's EEPROM specified by page and bank numbers along with offset and length. It is effectively a netlink replacement for get_module_info() and get_module_eeprom() pair, which is needed due to emergence of complex non-linear EEPROM layouts. Signed-off-by: Vladyslav Tarasiuk <vladyslavt@nvidia.com> Signed-off-by: David S. Miller <davem@davemloft.net>
- Loading branch information
Vladyslav Tarasiuk
authored and
David S. Miller
committed
Apr 11, 2021
1 parent
cbd3125
commit c781ff1
Showing
7 changed files
with
270 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| // SPDX-License-Identifier: GPL-2.0-only | ||
|
|
||
| #include <linux/ethtool.h> | ||
| #include "netlink.h" | ||
| #include "common.h" | ||
|
|
||
| struct eeprom_req_info { | ||
| struct ethnl_req_info base; | ||
| u32 offset; | ||
| u32 length; | ||
| u8 page; | ||
| u8 bank; | ||
| u8 i2c_address; | ||
| }; | ||
|
|
||
| struct eeprom_reply_data { | ||
| struct ethnl_reply_data base; | ||
| u32 length; | ||
| u8 *data; | ||
| }; | ||
|
|
||
| #define MODULE_EEPROM_REQINFO(__req_base) \ | ||
| container_of(__req_base, struct eeprom_req_info, base) | ||
|
|
||
| #define MODULE_EEPROM_REPDATA(__reply_base) \ | ||
| container_of(__reply_base, struct eeprom_reply_data, base) | ||
|
|
||
| static int eeprom_prepare_data(const struct ethnl_req_info *req_base, | ||
| struct ethnl_reply_data *reply_base, | ||
| struct genl_info *info) | ||
| { | ||
| struct eeprom_reply_data *reply = MODULE_EEPROM_REPDATA(reply_base); | ||
| struct eeprom_req_info *request = MODULE_EEPROM_REQINFO(req_base); | ||
| struct ethtool_module_eeprom page_data = {0}; | ||
| struct net_device *dev = reply_base->dev; | ||
| int ret; | ||
|
|
||
| if (!dev->ethtool_ops->get_module_eeprom_by_page) | ||
| return -EOPNOTSUPP; | ||
|
|
||
| page_data.offset = request->offset; | ||
| page_data.length = request->length; | ||
| page_data.i2c_address = request->i2c_address; | ||
| page_data.page = request->page; | ||
| page_data.bank = request->bank; | ||
| page_data.data = kmalloc(page_data.length, GFP_KERNEL); | ||
| if (!page_data.data) | ||
| return -ENOMEM; | ||
|
|
||
| ret = ethnl_ops_begin(dev); | ||
| if (ret) | ||
| goto err_free; | ||
|
|
||
| ret = dev->ethtool_ops->get_module_eeprom_by_page(dev, &page_data, | ||
| info->extack); | ||
| if (ret < 0) | ||
| goto err_ops; | ||
|
|
||
| reply->length = ret; | ||
| reply->data = page_data.data; | ||
|
|
||
| ethnl_ops_complete(dev); | ||
| return 0; | ||
|
|
||
| err_ops: | ||
| ethnl_ops_complete(dev); | ||
| err_free: | ||
| kfree(page_data.data); | ||
| return ret; | ||
| } | ||
|
|
||
| static int eeprom_parse_request(struct ethnl_req_info *req_info, struct nlattr **tb, | ||
| struct netlink_ext_ack *extack) | ||
| { | ||
| struct eeprom_req_info *request = MODULE_EEPROM_REQINFO(req_info); | ||
|
|
||
| if (!tb[ETHTOOL_A_MODULE_EEPROM_OFFSET] || | ||
| !tb[ETHTOOL_A_MODULE_EEPROM_LENGTH] || | ||
| !tb[ETHTOOL_A_MODULE_EEPROM_PAGE] || | ||
| !tb[ETHTOOL_A_MODULE_EEPROM_I2C_ADDRESS]) | ||
| return -EINVAL; | ||
|
|
||
| request->i2c_address = nla_get_u8(tb[ETHTOOL_A_MODULE_EEPROM_I2C_ADDRESS]); | ||
| request->offset = nla_get_u32(tb[ETHTOOL_A_MODULE_EEPROM_OFFSET]); | ||
| request->length = nla_get_u32(tb[ETHTOOL_A_MODULE_EEPROM_LENGTH]); | ||
|
|
||
| if (!request->length) | ||
| return -EINVAL; | ||
|
|
||
| /* The following set of conditions limit the API to only dump 1/2 | ||
| * EEPROM page without crossing low page boundary located at offset 128. | ||
| * This means user may only request dumps of length limited to 128 from | ||
| * either low 128 bytes or high 128 bytes. | ||
| * For pages higher than 0 only high 128 bytes are accessible. | ||
| */ | ||
| request->page = nla_get_u8(tb[ETHTOOL_A_MODULE_EEPROM_PAGE]); | ||
| if (request->page && request->offset < ETH_MODULE_EEPROM_PAGE_LEN) { | ||
| NL_SET_ERR_MSG_ATTR(extack, tb[ETHTOOL_A_MODULE_EEPROM_PAGE], | ||
| "reading from lower half page is allowed for page 0 only"); | ||
| return -EINVAL; | ||
| } | ||
|
|
||
| if (request->offset < ETH_MODULE_EEPROM_PAGE_LEN && | ||
| request->offset + request->length > ETH_MODULE_EEPROM_PAGE_LEN) { | ||
| NL_SET_ERR_MSG_ATTR(extack, tb[ETHTOOL_A_MODULE_EEPROM_LENGTH], | ||
| "reading cross half page boundary is illegal"); | ||
| return -EINVAL; | ||
| } else if (request->offset >= ETH_MODULE_EEPROM_PAGE_LEN * 2) { | ||
| NL_SET_ERR_MSG_ATTR(extack, tb[ETHTOOL_A_MODULE_EEPROM_OFFSET], | ||
| "offset is out of bounds"); | ||
| return -EINVAL; | ||
| } else if (request->offset + request->length > ETH_MODULE_EEPROM_PAGE_LEN * 2) { | ||
| NL_SET_ERR_MSG_ATTR(extack, tb[ETHTOOL_A_MODULE_EEPROM_LENGTH], | ||
| "reading cross page boundary is illegal"); | ||
| return -EINVAL; | ||
| } | ||
|
|
||
| if (tb[ETHTOOL_A_MODULE_EEPROM_BANK]) | ||
| request->bank = nla_get_u8(tb[ETHTOOL_A_MODULE_EEPROM_BANK]); | ||
|
|
||
| return 0; | ||
| } | ||
|
|
||
| static int eeprom_reply_size(const struct ethnl_req_info *req_base, | ||
| const struct ethnl_reply_data *reply_base) | ||
| { | ||
| const struct eeprom_req_info *request = MODULE_EEPROM_REQINFO(req_base); | ||
|
|
||
| return nla_total_size(sizeof(u8) * request->length); /* _EEPROM_DATA */ | ||
| } | ||
|
|
||
| static int eeprom_fill_reply(struct sk_buff *skb, | ||
| const struct ethnl_req_info *req_base, | ||
| const struct ethnl_reply_data *reply_base) | ||
| { | ||
| struct eeprom_reply_data *reply = MODULE_EEPROM_REPDATA(reply_base); | ||
|
|
||
| return nla_put(skb, ETHTOOL_A_MODULE_EEPROM_DATA, reply->length, reply->data); | ||
| } | ||
|
|
||
| static void eeprom_cleanup_data(struct ethnl_reply_data *reply_base) | ||
| { | ||
| struct eeprom_reply_data *reply = MODULE_EEPROM_REPDATA(reply_base); | ||
|
|
||
| kfree(reply->data); | ||
| } | ||
|
|
||
| const struct ethnl_request_ops ethnl_module_eeprom_request_ops = { | ||
| .request_cmd = ETHTOOL_MSG_MODULE_EEPROM_GET, | ||
| .reply_cmd = ETHTOOL_MSG_MODULE_EEPROM_GET_REPLY, | ||
| .hdr_attr = ETHTOOL_A_MODULE_EEPROM_HEADER, | ||
| .req_info_size = sizeof(struct eeprom_req_info), | ||
| .reply_data_size = sizeof(struct eeprom_reply_data), | ||
|
|
||
| .parse_request = eeprom_parse_request, | ||
| .prepare_data = eeprom_prepare_data, | ||
| .reply_size = eeprom_reply_size, | ||
| .fill_reply = eeprom_fill_reply, | ||
| .cleanup_data = eeprom_cleanup_data, | ||
| }; | ||
|
|
||
| const struct nla_policy ethnl_module_eeprom_get_policy[] = { | ||
| [ETHTOOL_A_MODULE_EEPROM_HEADER] = NLA_POLICY_NESTED(ethnl_header_policy), | ||
| [ETHTOOL_A_MODULE_EEPROM_OFFSET] = { .type = NLA_U32 }, | ||
| [ETHTOOL_A_MODULE_EEPROM_LENGTH] = { .type = NLA_U32 }, | ||
| [ETHTOOL_A_MODULE_EEPROM_PAGE] = { .type = NLA_U8 }, | ||
| [ETHTOOL_A_MODULE_EEPROM_BANK] = { .type = NLA_U8 }, | ||
| [ETHTOOL_A_MODULE_EEPROM_I2C_ADDRESS] = | ||
| NLA_POLICY_RANGE(NLA_U8, 0, ETH_MODULE_MAX_I2C_ADDRESS), | ||
| }; | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters