fpga: manager: add owner module and take its refcount
authorMarco Pagani <marpagan@redhat.com>
Tue, 5 Mar 2024 19:29:26 +0000 (20:29 +0100)
committerXu Yilun <yilun.xu@linux.intel.com>
Sun, 31 Mar 2024 13:50:39 +0000 (21:50 +0800)
commit4d4d2d4346857bf778fafaa97d6f76bb1663e3c9
tree1244dad0059e080171a59fa2e69f526744df63fa
parent4cece764965020c22cff7665b18a012006359095
fpga: manager: add owner module and take its refcount

The current implementation of the fpga manager assumes that the low-level
module registers a driver for the parent device and uses its owner pointer
to take the module's refcount. This approach is problematic since it can
lead to a null pointer dereference while attempting to get the manager if
the parent device does not have a driver.

To address this problem, add a module owner pointer to the fpga_manager
struct and use it to take the module's refcount. Modify the functions for
registering the manager to take an additional owner module parameter and
rename them to avoid conflicts. Use the old function names for helper
macros that automatically set the module that registers the manager as the
owner. This ensures compatibility with existing low-level control modules
and reduces the chances of registering a manager without setting the owner.

Also, update the documentation to keep it consistent with the new interface
for registering an fpga manager.

Other changes: opportunistically move put_device() from __fpga_mgr_get() to
fpga_mgr_get() and of_fpga_mgr_get() to improve code clarity since the
manager device is taken in these functions.

Fixes: 654ba4cc0f3e ("fpga manager: ensure lifetime with of_fpga_mgr_get")
Suggested-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Suggested-by: Xu Yilun <yilun.xu@intel.com>
Signed-off-by: Marco Pagani <marpagan@redhat.com>
Acked-by: Xu Yilun <yilun.xu@intel.com>
Link: https://lore.kernel.org/r/20240305192926.84886-1-marpagan@redhat.com
Signed-off-by: Xu Yilun <yilun.xu@linux.intel.com>
Documentation/driver-api/fpga/fpga-mgr.rst
drivers/fpga/fpga-mgr.c
include/linux/fpga/fpga-mgr.h