Philipp Stanner 81fcf28e74
PCI: Document hybrid devres hazards
These functions:

  pci_request_region()
  pci_request_regions()
  pci_request_regions_exclusive()
  pci_request_selected_regions()
  pci_request_selected_regions_exclusive()
  pci_intx()

are "hybrid" functions that are managed if pcim_enable_device() has been
called, but unmanaged otherwise.

This is confusing and has already caused a bug (in 8558de401b5f
("drm/vboxvideo: use managed pci functions")) because users believe all PCI
functions, such as pci_iomap_range(), can become managed that way, which is
not the case.

Add comments to the relevant functions' docstrings that warn users about
this behavior.

Link: https://lore.kernel.org/r/20240613115032.29098-7-pstanner@redhat.com
Signed-off-by: Philipp Stanner <pstanner@redhat.com>
Signed-off-by: Krzysztof Wilczyński <kwilczynski@kernel.org>
[bhelgaas: commit log]
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
2024-07-10 04:20:01 +00:00
..
2024-05-16 18:14:13 -05:00
2024-05-16 18:14:14 -05:00
2024-05-21 10:09:28 -07:00
2024-05-16 18:14:14 -05:00
2023-10-24 16:55:45 -05:00
2024-04-09 09:33:15 -05:00
2024-07-10 04:20:01 +00:00
2024-02-12 10:35:40 -06:00
2024-03-12 12:14:23 -05:00
2023-10-28 13:30:59 -05:00
2024-03-12 12:14:24 -05:00
2024-07-10 04:20:01 +00:00
2024-07-10 04:19:56 +00:00
2024-05-16 18:14:14 -05:00
2024-05-21 10:09:28 -07:00
2023-09-28 16:49:44 -05:00
2023-10-24 16:55:45 -05:00
2023-11-02 14:05:18 -10:00