linux/Documentation/driver-api/fpga
Marco Pagani b7c0e1ecee
fpga: region: add owner module and take its refcount
The current implementation of the fpga region 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 region
during programming if the parent device does not have a driver.

To address this problem, add a module owner pointer to the fpga_region
struct and use it to take the module's refcount. Modify the functions for
registering a region 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 region as the
owner. This ensures compatibility with existing low-level control modules
and reduces the chances of registering a region without setting the owner.

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

Fixes: 0fa20cdfcc ("fpga: fpga-region: device tree control for FPGA")
Suggested-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Suggested-by: Xu Yilun <yilun.xu@intel.com>
Reviewed-by: Russ Weight <russ.weight@linux.dev>
Signed-off-by: Marco Pagani <marpagan@redhat.com>
Acked-by: Xu Yilun <yilun.xu@intel.com>
Link: https://lore.kernel.org/r/20240419083601.77403-1-marpagan@redhat.com
Signed-off-by: Xu Yilun <yilun.xu@linux.intel.com>
2024-04-23 15:37:20 +08:00
..
fpga-bridge.rst fpga: bridge: add owner module and take its refcount 2024-03-31 21:54:44 +08:00
fpga-mgr.rst fpga: manager: add owner module and take its refcount 2024-03-31 21:50:39 +08:00
fpga-programming.rst docs: driver-api: fpga: avoid using UTF-8 chars 2021-07-21 19:54:21 -07:00
fpga-region.rst fpga: region: add owner module and take its refcount 2024-04-23 15:37:20 +08:00
index.rst docs: fpga: document programming fpgas using regions 2018-10-16 11:13:50 +02:00
intro.rst docs: fpga: document programming fpgas using regions 2018-10-16 11:13:50 +02:00