| Message ID | 20240809095248.14220-2-pstanner@redhat.com (mailing list archive) |
|---|---|
| State | Handled Elsewhere |
| Headers | show |
| Series | [RESEND] Documentation: devres: fix error about PCI devres | expand |
On Fri, Aug 09, 2024 at 11:52:48AM +0200, Philipp Stanner wrote: > The documentation states that pcim_enable_device() will make "all PCI > ops" managed. This is totally false, only a small subset of PCI > functions become managed that way. Implicating otherwise has caused at > least one bug so far, namely in commit 8558de401b5f ("drm/vboxvideo: use > managed pci functions"). > > Change the function summary so the functions dangerous behavior becomes > obvious. > > Signed-off-by: Philipp Stanner <pstanner@redhat.com> Acked-by: Bjorn Helgaas <bhelgaas@google.com> s/Implicating/Suggesting/ s/functions dangerous/function's dangerous/ > --- > +CC PCI and Bjorn. > > Bjorn, btw. neither PCI nor you are printed by getmaintainers for the > touched document. Possibly one might want to think about fixing that > somehow. > But I don't think it's a huge deal. > --- > Documentation/driver-api/driver-model/devres.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/driver-api/driver-model/devres.rst b/Documentation/driver-api/driver-model/devres.rst > index ac9ee7441887..5f2ee8d717b1 100644 > --- a/Documentation/driver-api/driver-model/devres.rst > +++ b/Documentation/driver-api/driver-model/devres.rst > @@ -391,7 +391,7 @@ PCI > devm_pci_remap_cfgspace() : ioremap PCI configuration space > devm_pci_remap_cfg_resource() : ioremap PCI configuration space resource > > - pcim_enable_device() : after success, all PCI ops become managed > + pcim_enable_device() : after success, some PCI ops become managed > pcim_iomap() : do iomap() on a single BAR > pcim_iomap_regions() : do request_region() and iomap() on multiple BARs > pcim_iomap_regions_request_all() : do request_region() on all and iomap() on multiple BARs > -- > 2.45.2 >
Philipp Stanner <pstanner@redhat.com> writes: > The documentation states that pcim_enable_device() will make "all PCI > ops" managed. This is totally false, only a small subset of PCI > functions become managed that way. Implicating otherwise has caused at > least one bug so far, namely in commit 8558de401b5f ("drm/vboxvideo: use > managed pci functions"). > > Change the function summary so the functions dangerous behavior becomes > obvious. > > Signed-off-by: Philipp Stanner <pstanner@redhat.com> > --- > +CC PCI and Bjorn. > > Bjorn, btw. neither PCI nor you are printed by getmaintainers for the > touched document. Possibly one might want to think about fixing that > somehow. > But I don't think it's a huge deal. > --- > Documentation/driver-api/driver-model/devres.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) Applied, thanks. jon
diff --git a/Documentation/driver-api/driver-model/devres.rst b/Documentation/driver-api/driver-model/devres.rst index ac9ee7441887..5f2ee8d717b1 100644 --- a/Documentation/driver-api/driver-model/devres.rst +++ b/Documentation/driver-api/driver-model/devres.rst @@ -391,7 +391,7 @@ PCI devm_pci_remap_cfgspace() : ioremap PCI configuration space devm_pci_remap_cfg_resource() : ioremap PCI configuration space resource - pcim_enable_device() : after success, all PCI ops become managed + pcim_enable_device() : after success, some PCI ops become managed pcim_iomap() : do iomap() on a single BAR pcim_iomap_regions() : do request_region() and iomap() on multiple BARs pcim_iomap_regions_request_all() : do request_region() on all and iomap() on multiple BARs
The documentation states that pcim_enable_device() will make "all PCI ops" managed. This is totally false, only a small subset of PCI functions become managed that way. Implicating otherwise has caused at least one bug so far, namely in commit 8558de401b5f ("drm/vboxvideo: use managed pci functions"). Change the function summary so the functions dangerous behavior becomes obvious. Signed-off-by: Philipp Stanner <pstanner@redhat.com> --- +CC PCI and Bjorn. Bjorn, btw. neither PCI nor you are printed by getmaintainers for the touched document. Possibly one might want to think about fixing that somehow. But I don't think it's a huge deal. --- Documentation/driver-api/driver-model/devres.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)