mbox series

[v4,0/3] fpga: Use standard class dev_release function

Message ID 20210528215755.839712-1-russell.h.weight@intel.com (mailing list archive)
Headers show
Series fpga: Use standard class dev_release function | expand

Message

Russ Weight May 28, 2021, 9:57 p.m. UTC
The FPGA framework has a convention of using managed resource
functions to allow parent drivers to manage the data structures
allocated by the class drivers. They use an empty *_dev_release()
function to satisfy the class driver.

This is inconsistent with linux driver model.

These changes remove the managed resource functions and populate
the class dev_release callback functions. They also merge the
create and register functions into a single register function for
each of the fpga-mgr, fpga-region, and fpga-bridge class drivers.

For more context, refer to this email thread:

https://marc.info/?l=linux-fpga&m=162127412218557&w=2

I turned on the configs assocated with each of the modified files,
but I must have been missing some dependencies, because not all
of them compiled. I did a run-time test specifically with the
dfl-fme infrastructure. This would have exercised the region,
bridge, and fpga-mgr frameworks.

Changelog v3 -> v4:
  - Added the compat_id parameter to fpga_mgr_register() and
    devm_fpga_mgr_register() to ensure that the compat_id is set before
    the device_register() call.
  - Added the compat_id parameter to fpga_bridge_register() to ensure
    that the compat_id is set before the device_register() call.
  - Modified the dfl_fpga_feature_devs_enumerate() function to restore
    the fpga_region_register() call to the correct location.

Changelog v2 -> v3:
  - Cleaned up comment headers for fpga_mgr_register(), fpga_bridge_register(),
    and fpga_region_register().
  - Fixed error return on ida_simple_get() failure for fpga_mgr_register(),
    fpga_bridge_register(), and fpga_region_register().
  - Fixed error return value for fpga_bridge_register(): ERR_PTR(ret) instead
    of NULL.

Changelog v1 -> v2:
  - Restored devm_fpga_mgr_register() functionality to the fpga-mgr
    class driver, adapted for the combined create/register functionality.
  - All previous callers of devm_fpga_mgr_register() will continue to call
    devm_fpga_mgr_register().
  - replaced unnecessary ternary operators in return statements with
    standard if conditions.

Russ Weight (3):
  fpga: mgr: Use standard dev_release for class driver
  fpga: bridge: Use standard dev_release for class driver
  fpga: region: Use standard dev_release for class driver

 drivers/fpga/altera-cvp.c           |  12 +-
 drivers/fpga/altera-fpga2sdram.c    |  12 +-
 drivers/fpga/altera-freeze-bridge.c |  10 +-
 drivers/fpga/altera-hps2fpga.c      |  12 +-
 drivers/fpga/altera-pr-ip-core.c    |   9 +-
 drivers/fpga/altera-ps-spi.c        |  10 +-
 drivers/fpga/dfl-fme-br.c           |  10 +-
 drivers/fpga/dfl-fme-mgr.c          |  12 +-
 drivers/fpga/dfl-fme-region.c       |  12 +-
 drivers/fpga/dfl.c                  |  12 +-
 drivers/fpga/fpga-bridge.c          | 119 +++++---------------
 drivers/fpga/fpga-mgr.c             | 168 ++++++++--------------------
 drivers/fpga/fpga-region.c          | 106 ++++--------------
 drivers/fpga/ice40-spi.c            |  10 +-
 drivers/fpga/machxo2-spi.c          |  10 +-
 drivers/fpga/of-fpga-region.c       |  10 +-
 drivers/fpga/socfpga-a10.c          |  16 +--
 drivers/fpga/socfpga.c              |  10 +-
 drivers/fpga/stratix10-soc.c        |  15 +--
 drivers/fpga/ts73xx-fpga.c          |  10 +-
 drivers/fpga/xilinx-pr-decoupler.c  |  17 +--
 drivers/fpga/xilinx-spi.c           |  12 +-
 drivers/fpga/zynq-fpga.c            |  16 +--
 drivers/fpga/zynqmp-fpga.c          |  10 +-
 include/linux/fpga/fpga-bridge.h    |  12 +-
 include/linux/fpga/fpga-mgr.h       |  19 ++--
 include/linux/fpga/fpga-region.h    |  13 +--
 27 files changed, 210 insertions(+), 474 deletions(-)

Comments

Xu Yilun May 31, 2021, 3:24 p.m. UTC | #1
On Fri, May 28, 2021 at 02:57:52PM -0700, Russ Weight wrote:
> The FPGA framework has a convention of using managed resource
> functions to allow parent drivers to manage the data structures
> allocated by the class drivers. They use an empty *_dev_release()
> function to satisfy the class driver.
> 
> This is inconsistent with linux driver model.
> 
> These changes remove the managed resource functions and populate
> the class dev_release callback functions. They also merge the
> create and register functions into a single register function for
> each of the fpga-mgr, fpga-region, and fpga-bridge class drivers.
> 
> For more context, refer to this email thread:
> 
> https://marc.info/?l=linux-fpga&m=162127412218557&w=2
> 
> I turned on the configs assocated with each of the modified files,
> but I must have been missing some dependencies, because not all
> of them compiled. I did a run-time test specifically with the
> dfl-fme infrastructure. This would have exercised the region,
> bridge, and fpga-mgr frameworks.
> 
> Changelog v3 -> v4:
>   - Added the compat_id parameter to fpga_mgr_register() and
>     devm_fpga_mgr_register() to ensure that the compat_id is set before
>     the device_register() call.
>   - Added the compat_id parameter to fpga_bridge_register() to ensure

A typo                             ... fpga_region_register() ...

Thanks,
Yilun

>     that the compat_id is set before the device_register() call.
>   - Modified the dfl_fpga_feature_devs_enumerate() function to restore
>     the fpga_region_register() call to the correct location.
> 
> Changelog v2 -> v3:
>   - Cleaned up comment headers for fpga_mgr_register(), fpga_bridge_register(),
>     and fpga_region_register().
>   - Fixed error return on ida_simple_get() failure for fpga_mgr_register(),
>     fpga_bridge_register(), and fpga_region_register().
>   - Fixed error return value for fpga_bridge_register(): ERR_PTR(ret) instead
>     of NULL.
> 
> Changelog v1 -> v2:
>   - Restored devm_fpga_mgr_register() functionality to the fpga-mgr
>     class driver, adapted for the combined create/register functionality.
>   - All previous callers of devm_fpga_mgr_register() will continue to call
>     devm_fpga_mgr_register().
>   - replaced unnecessary ternary operators in return statements with
>     standard if conditions.
> 
> Russ Weight (3):
>   fpga: mgr: Use standard dev_release for class driver
>   fpga: bridge: Use standard dev_release for class driver
>   fpga: region: Use standard dev_release for class driver
> 
>  drivers/fpga/altera-cvp.c           |  12 +-
>  drivers/fpga/altera-fpga2sdram.c    |  12 +-
>  drivers/fpga/altera-freeze-bridge.c |  10 +-
>  drivers/fpga/altera-hps2fpga.c      |  12 +-
>  drivers/fpga/altera-pr-ip-core.c    |   9 +-
>  drivers/fpga/altera-ps-spi.c        |  10 +-
>  drivers/fpga/dfl-fme-br.c           |  10 +-
>  drivers/fpga/dfl-fme-mgr.c          |  12 +-
>  drivers/fpga/dfl-fme-region.c       |  12 +-
>  drivers/fpga/dfl.c                  |  12 +-
>  drivers/fpga/fpga-bridge.c          | 119 +++++---------------
>  drivers/fpga/fpga-mgr.c             | 168 ++++++++--------------------
>  drivers/fpga/fpga-region.c          | 106 ++++--------------
>  drivers/fpga/ice40-spi.c            |  10 +-
>  drivers/fpga/machxo2-spi.c          |  10 +-
>  drivers/fpga/of-fpga-region.c       |  10 +-
>  drivers/fpga/socfpga-a10.c          |  16 +--
>  drivers/fpga/socfpga.c              |  10 +-
>  drivers/fpga/stratix10-soc.c        |  15 +--
>  drivers/fpga/ts73xx-fpga.c          |  10 +-
>  drivers/fpga/xilinx-pr-decoupler.c  |  17 +--
>  drivers/fpga/xilinx-spi.c           |  12 +-
>  drivers/fpga/zynq-fpga.c            |  16 +--
>  drivers/fpga/zynqmp-fpga.c          |  10 +-
>  include/linux/fpga/fpga-bridge.h    |  12 +-
>  include/linux/fpga/fpga-mgr.h       |  19 ++--
>  include/linux/fpga/fpga-region.h    |  13 +--
>  27 files changed, 210 insertions(+), 474 deletions(-)
> 
> -- 
> 2.25.1
Russ Weight June 3, 2021, 10:49 p.m. UTC | #2
On 5/31/21 8:24 AM, Xu Yilun wrote:
> On Fri, May 28, 2021 at 02:57:52PM -0700, Russ Weight wrote:
>> The FPGA framework has a convention of using managed resource
>> functions to allow parent drivers to manage the data structures
>> allocated by the class drivers. They use an empty *_dev_release()
>> function to satisfy the class driver.
>>
>> This is inconsistent with linux driver model.
>>
>> These changes remove the managed resource functions and populate
>> the class dev_release callback functions. They also merge the
>> create and register functions into a single register function for
>> each of the fpga-mgr, fpga-region, and fpga-bridge class drivers.
>>
>> For more context, refer to this email thread:
>>
>> https://marc.info/?l=linux-fpga&m=162127412218557&w=2
>>
>> I turned on the configs assocated with each of the modified files,
>> but I must have been missing some dependencies, because not all
>> of them compiled. I did a run-time test specifically with the
>> dfl-fme infrastructure. This would have exercised the region,
>> bridge, and fpga-mgr frameworks.
>>
>> Changelog v3 -> v4:
>>   - Added the compat_id parameter to fpga_mgr_register() and
>>     devm_fpga_mgr_register() to ensure that the compat_id is set before
>>     the device_register() call.
>>   - Added the compat_id parameter to fpga_bridge_register() to ensure
> A typo                             ... fpga_region_register() ...
Thanks Yilun - I'll fix that.

- Russ
>
> Thanks,
> Yilun
>
>>     that the compat_id is set before the device_register() call.
>>   - Modified the dfl_fpga_feature_devs_enumerate() function to restore
>>     the fpga_region_register() call to the correct location.
>>
>> Changelog v2 -> v3:
>>   - Cleaned up comment headers for fpga_mgr_register(), fpga_bridge_register(),
>>     and fpga_region_register().
>>   - Fixed error return on ida_simple_get() failure for fpga_mgr_register(),
>>     fpga_bridge_register(), and fpga_region_register().
>>   - Fixed error return value for fpga_bridge_register(): ERR_PTR(ret) instead
>>     of NULL.
>>
>> Changelog v1 -> v2:
>>   - Restored devm_fpga_mgr_register() functionality to the fpga-mgr
>>     class driver, adapted for the combined create/register functionality.
>>   - All previous callers of devm_fpga_mgr_register() will continue to call
>>     devm_fpga_mgr_register().
>>   - replaced unnecessary ternary operators in return statements with
>>     standard if conditions.
>>
>> Russ Weight (3):
>>   fpga: mgr: Use standard dev_release for class driver
>>   fpga: bridge: Use standard dev_release for class driver
>>   fpga: region: Use standard dev_release for class driver
>>
>>  drivers/fpga/altera-cvp.c           |  12 +-
>>  drivers/fpga/altera-fpga2sdram.c    |  12 +-
>>  drivers/fpga/altera-freeze-bridge.c |  10 +-
>>  drivers/fpga/altera-hps2fpga.c      |  12 +-
>>  drivers/fpga/altera-pr-ip-core.c    |   9 +-
>>  drivers/fpga/altera-ps-spi.c        |  10 +-
>>  drivers/fpga/dfl-fme-br.c           |  10 +-
>>  drivers/fpga/dfl-fme-mgr.c          |  12 +-
>>  drivers/fpga/dfl-fme-region.c       |  12 +-
>>  drivers/fpga/dfl.c                  |  12 +-
>>  drivers/fpga/fpga-bridge.c          | 119 +++++---------------
>>  drivers/fpga/fpga-mgr.c             | 168 ++++++++--------------------
>>  drivers/fpga/fpga-region.c          | 106 ++++--------------
>>  drivers/fpga/ice40-spi.c            |  10 +-
>>  drivers/fpga/machxo2-spi.c          |  10 +-
>>  drivers/fpga/of-fpga-region.c       |  10 +-
>>  drivers/fpga/socfpga-a10.c          |  16 +--
>>  drivers/fpga/socfpga.c              |  10 +-
>>  drivers/fpga/stratix10-soc.c        |  15 +--
>>  drivers/fpga/ts73xx-fpga.c          |  10 +-
>>  drivers/fpga/xilinx-pr-decoupler.c  |  17 +--
>>  drivers/fpga/xilinx-spi.c           |  12 +-
>>  drivers/fpga/zynq-fpga.c            |  16 +--
>>  drivers/fpga/zynqmp-fpga.c          |  10 +-
>>  include/linux/fpga/fpga-bridge.h    |  12 +-
>>  include/linux/fpga/fpga-mgr.h       |  19 ++--
>>  include/linux/fpga/fpga-region.h    |  13 +--
>>  27 files changed, 210 insertions(+), 474 deletions(-)
>>
>> -- 
>> 2.25.1