Re: [PATCH 6/6] (v3) drivers: hwmon: i5k_amb: simplify probing / device identification

[Bjorn Helgaas <helgaas@kernel.org>]

On Thu, Nov 28, 2019 at 06:21:31AM -0800, Guenter Roeck wrote:
> On 11/28/19 4:54 AM, Enrico Weigelt, metux IT consult wrote:
> > Simpilify the probing by putting all chip-specific data directly
> > into the pci match table, removing the redundant chipset_ids table.
> > 
> > Changes v3:
> >      * use pci_get_device_by_id() introduces by a previous patch
> >        of this queue
> > 
> > Changes v2:
> >      * use PCI_DEVICE_DATA() macro in the pci match table
> >      * directly pass the pci device id to i5k_channel_probe(),
> >        instead of computing it internally by extra offset parameter
> > 
> > Submitted: 2019-06-06
> > Signed-off-by: Enrico Weigelt <info@metux.net>
> 
> I don't immediately see how this is better. I am not even sure if it
> is correct.

I don't mind this, but:

  1) I don't maintain this file, so my opinion doesn't count much.

  2) I despise the pci_get_device() interfaces because they're
  inefficient, not hotplug-safe, they circumvent the device model
  claim mechanism, and it's hard to do the reference counting
  correctly.

  3) There are several things going on in this patch and it would be
  easier to read if you could split them into separate patches:

    - Removing the redundancy between chipset_ids[] and i5k_amb_ids[].
      This seems like a nice change.

    - The "chipset_ids[i].fbd0 + 1" thing was weird and the new
      ".driver_data + 1" is still weird.  Those are PCI device IDs,
      and addition is not a valid operation on those IDs.  IMHO both
      PCI_DEVICE_ID_INTEL_5000_FBD0 and PCI_DEVICE_ID_INTEL_5000_FBD1
      should be listed explicitly in the driver instead of trying to
      compute PCI_DEVICE_ID_INTEL_5000_FBD1.

    - Replacing the hard-coding of PCI_VENDOR_ID_INTEL with the vendor
      ID from i5k_amb_ids[] seems worthwhile and should be its own
      separate patch (if possible).

    - Changing to use pci_get_device_by_id().  This should be trivial
      to verify, like the other patches.

> > ---
> >   drivers/hwmon/i5k_amb.c | 38 +++++++++++++++-----------------------
> >   1 file changed, 15 insertions(+), 23 deletions(-)
> > 
> > diff --git a/drivers/hwmon/i5k_amb.c b/drivers/hwmon/i5k_amb.c
> > index b09c39abd3a8..cb85607d104f 100644
> > --- a/drivers/hwmon/i5k_amb.c
> > +++ b/drivers/hwmon/i5k_amb.c
> > @@ -414,16 +414,14 @@ static int i5k_amb_add(void)
> >   }
> >   static int i5k_find_amb_registers(struct i5k_amb_data *data,
> > -					    unsigned long devid)
> > +				  const struct pci_device_id *devid)
> >   {
> >   	struct pci_dev *pcidev;
> >   	u32 val32;
> >   	int res = -ENODEV;
> >   	/* Find AMB register memory space */
> > -	pcidev = pci_get_device(PCI_VENDOR_ID_INTEL,
> > -				devid,
> > -				NULL);
> > +	pcidev = pci_get_device_by_id(devid);
> >   	if (!pcidev)
> >   		return -ENODEV;
> > @@ -447,14 +445,15 @@ static int i5k_find_amb_registers(struct i5k_amb_data *data,
> >   	return res;
> >   }
> > -static int i5k_channel_probe(u16 *amb_present, unsigned long dev_id)
> > +static int i5k_channel_probe(u16 *amb_present, unsigned int vendor,
> > +			     unsigned int device)
> >   {
> >   	struct pci_dev *pcidev;
> >   	u16 val16;
> >   	int res = -ENODEV;
> >   	/* Copy the DIMM presence map for these two channels */
> > -	pcidev = pci_get_device(PCI_VENDOR_ID_INTEL, dev_id, NULL);
> > +	pcidev = pci_get_device(vendor, device, NULL);
> >   	if (!pcidev)
> >   		return -ENODEV;
> > @@ -473,23 +472,12 @@ static int i5k_channel_probe(u16 *amb_present, unsigned long dev_id)
> >   	return res;
> >   }
> > -static struct {
> > -	unsigned long err;
> > -	unsigned long fbd0;
> > -} chipset_ids[]  = {
> > -	{ PCI_DEVICE_ID_INTEL_5000_ERR, PCI_DEVICE_ID_INTEL_5000_FBD0 },
> > -	{ PCI_DEVICE_ID_INTEL_5400_ERR, PCI_DEVICE_ID_INTEL_5400_FBD0 },
> > -	{ 0, 0 }
> > -};
> > -
> > -#ifdef MODULE
> >   static const struct pci_device_id i5k_amb_ids[] = {
> > -	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_5000_ERR) },
> > -	{ PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_5400_ERR) },
> > +	{ PCI_DEVICE_DATA(INTEL, 5000_ERR, PCI_DEVICE_ID_INTEL_5000_FBD0) },
> > +	{ PCI_DEVICE_DATA(INTEL, 5400_ERR, PCI_DEVICE_ID_INTEL_5400_FBD0) },
> >   	{ 0, }
> >   };
> >   MODULE_DEVICE_TABLE(pci, i5k_amb_ids);
> > -#endif
> >   static int i5k_amb_probe(struct platform_device *pdev)
> >   {
> > @@ -504,22 +492,26 @@ static int i5k_amb_probe(struct platform_device *pdev)
> >   	/* Figure out where the AMB registers live */
> >   	i = 0;
> >   	do {
> > -		res = i5k_find_amb_registers(data, chipset_ids[i].err);
> > +		res = i5k_find_amb_registers(data, &i5k_amb_ids[i]);
> >   		if (res == 0)
> >   			break;
> >   		i++;
> > -	} while (chipset_ids[i].err);
> > +	} while (i5k_amb_ids[i].device);
> >   	if (res)
> >   		goto err;
> >   	/* Copy the DIMM presence map for the first two channels */
> > -	res = i5k_channel_probe(&data->amb_present[0], chipset_ids[i].fbd0);
> > +	res = i5k_channel_probe(&data->amb_present[0],
> > +				i5k_amb_ids[i].vendor,
> > +				i5k_amb_ids[i].driver_data);
> >   	if (res)
> >   		goto err;
> >   	/* Copy the DIMM presence map for the optional second two channels */
> > -	i5k_channel_probe(&data->amb_present[2], chipset_ids[i].fbd0 + 1);
> > +	i5k_channel_probe(&data->amb_present[2],
> > +			  i5k_amb_ids[i].vendor,
> > +			  i5k_amb_ids[i].driver_data+1);
> >   	/* Set up resource regions */
> >   	reso = request_mem_region(data->amb_base, data->amb_len, DRVNAME);
> > 
>