RE: [RFC PATCH net-next 9/9] ethtool: Add ability to flash transceiver modules' firmware

From: Danielle Ratson <danieller@nvidia.com>
To: Russell King <linux@armlinux.org.uk>
Cc: "netdev@vger.kernel.org" <netdev@vger.kernel.org>,
	"davem@davemloft.net" <davem@davemloft.net>,
	"edumazet@google.com" <edumazet@google.com>,
	"kuba@kernel.org" <kuba@kernel.org>,
	"pabeni@redhat.com" <pabeni@redhat.com>,
	"corbet@lwn.net" <corbet@lwn.net>,
	"sdf@google.com" <sdf@google.com>,
	"kory.maincent@bootlin.com" <kory.maincent@bootlin.com>,
	"maxime.chevallier@bootlin.com" <maxime.chevallier@bootlin.com>,
	"vladimir.oltean@nxp.com" <vladimir.oltean@nxp.com>,
	"przemyslaw.kitszel@intel.com" <przemyslaw.kitszel@intel.com>,
	"ahmed.zaki@intel.com" <ahmed.zaki@intel.com>,
	"richardcochran@gmail.com" <richardcochran@gmail.com>,
	"shayagr@amazon.com" <shayagr@amazon.com>,
	"paul.greenwalt@intel.com" <paul.greenwalt@intel.com>,
	"jiri@resnulli.us" <jiri@resnulli.us>,
	"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	mlxsw <mlxsw@nvidia.com>, Petr Machata <petrm@nvidia.com>,
	Ido Schimmel <idosch@nvidia.com>
Subject: RE: [RFC PATCH net-next 9/9] ethtool: Add ability to flash transceiver modules' firmware
Date: Wed, 24 Jan 2024 13:11:22 +0000	[thread overview]
Message-ID: <DM6PR12MB451661BE50E8FECF6393ACDDD87B2@DM6PR12MB4516.namprd12.prod.outlook.com> (raw)
In-Reply-To: <Za/pBGBB3H+VEbX8@shell.armlinux.org.uk>

> > +#define MODULE_EEPROM_PAGE	0
> > +#define MODULE_EEPROM_OFFSET	0
> > +#define MODULE_EEPROM_LENGTH	1
> > +#define MODULE_EEPROM_I2C_ADDR	0x50
> > +
> > +static int module_flash_fw_work_init(struct ethtool_module_fw_flash
> *module_fw,
> > +				     struct net_device *dev,
> > +				     struct netlink_ext_ack *extack) {
> > +	const struct ethtool_ops *ops = dev->ethtool_ops;
> > +	struct ethtool_module_eeprom page_data = {};
> > +	struct module_sff8024_id_rpl *rpl;
> > +	int err;
> > +
> > +	/* Fetch the SFF-8024 Identifier Value. For all supported standards, it
> > +	 * is located at I2C address 0x50, byte 0. See section 4.1 in SFF-8024,
> > +	 * revision 4.9.
> > +	 */
> > +	page_data.page = MODULE_EEPROM_PAGE;
> > +	page_data.offset = MODULE_EEPROM_OFFSET;
> > +	page_data.length = MODULE_EEPROM_LENGTH;
> > +	page_data.i2c_address = MODULE_EEPROM_I2C_ADDR;
> 
> Please use better names - these aren't any better than using integers.
> 
> Maybe use SFP_PHYS_ID for the offset?
> 
> > +	page_data.data = kmalloc(page_data.length, GFP_KERNEL);
> > +	if (!page_data.data)
> > +		return -ENOMEM;
> > +
> > +	err = ops->get_module_eeprom_by_page(dev, &page_data, extack);
> > +	if (err < 0)
> > +		goto out;
> > +
> > +	rpl = (struct module_sff8024_id_rpl *)page_data.data;
> 
> What purpose does this structure of a single byte serve? To me, it just
> obfuscates the code.
> 
> 	u8 phys_id;
> 
> 	...
> 	page_data.offset = SFP_PHYS_ID;
> 	page_data.length = sizeof(phys_id);
> 	page_data.data = &phys_id;
> 	...
> 	switch (phys_id) {
> 
> will work just as well, and be more explicit about what's actually going on
> here. It doesn't mean that I have to understand what this new
> module_sff8024_id_rpl structure is. I can see that we're just getting one byte
> which is the module physical ID.
> 
> You also then don't need to care about kfree()ing one byte of data structure.

OK, will change, thanks!

> 
> --
> RMK's Patch system: https://www.armlinux.org.uk/developer/patches/
> FTTP is here! 80Mbps down 10Mbps up. Decent connectivity at last!