sst-linux/Documentation/driver-api
Marco Pagani 304f8032d6 fpga: manager: add owner module and take its refcount
[ Upstream commit 4d4d2d4346857bf778fafaa97d6f76bb1663e3c9 ]

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: 654ba4cc0f ("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>
Signed-off-by: Sasha Levin <sashal@kernel.org>
Signed-off-by: Xiangyu Chen <xiangyu.chen@windriver.com>
Signed-off-by: Sasha Levin <sashal@kernel.org>
2024-12-14 19:53:12 +01:00
..
80211
acpi
backlight
cxl
dmaengine
driver-model
early-userspace
firmware
fpga
gpio
hte
i3c
iio
md
media
mei
memory-devices
mmc
mtd
nfc
nvdimm
pci
phy
pldmfw
pm
rapidio
serial
soundwire
surface_aggregator
thermal
tty
usb
xilinx
aperture.rst
auxiliary_bus.rst
basics.rst
clk.rst
component.rst
connector.rst
console.rst
dcdbas.rst
devfreq.rst
device_link.rst
device-io.rst
dma-buf.rst
edac.rst
eisa.rst
firewire.rst
frame-buffer.rst
generic-counter.rst
hsi.rst
i2c.rst
index.rst
infiniband.rst
infrastructure.rst
input.rst
interconnect.rst
io_ordering.rst
io-mapping.rst
ioctl.rst
ipmb.rst
ipmi.rst
isa.rst
isapnp.rst
libata.rst
mailbox.rst
men-chameleon-bus.rst
message-based.rst
misc_devices.rst
miscellaneous.rst
mtdnand.rst
ntb.rst
nvmem.rst
parport-lowlevel.rst
pin-control.rst
pps.rst
ptp.rst
pwm.rst
regulator.rst
reset.rst
rfkill.rst
s390-drivers.rst
scsi.rst
slimbus.rst
sm501.rst
spi.rst
switchtec.rst
sync_file.rst
target.rst
uio-howto.rst
vfio-mediated-device.rst
vfio-pci-device-specific-driver-acceptance.rst
vfio.rst
vme.rst
w1.rst
xillybus.rst
zorro.rst