mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2024-11-22 04:38:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

PCI: Deprecate pcim_iomap_table(), pcim_iomap_regions_request_all()

Browse Source 
Deprecate pcim_iomap_table().  It returns a pointer to a table of
ioremapped BARs, or NULL if it fails.  This makes uses like this:

  addr = pcim_iomap_table(pdev)[0];

problematic because it causes a NULL pointer dereference on failure.
Callers should use pcim_iomap() instead.

Deprecate pcim_iomap_regions_request_all() because it is built on
__pci_request_region() and is managed if pcim_enable_device() has been
called, but unmanaged otherwise, which is prone to errors.

Callers should either use pcim_iomap_regions() to request and map BARs, or
use pcim_request_region() followed by pcim_iomap().

Link: https://lore.kernel.org/r/20240613115032.29098-5-pstanner@redhat.com
Signed-off-by: Philipp Stanner <pstanner@redhat.com>
Signed-off-by: Krzysztof Wilczyński <kwilczynski@kernel.org>
[bhelgaas: commit log, sphinx markup]
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
This commit is contained in:
Philipp Stanner 2024-06-13 13:50:17 +02:00 committed by Krzysztof Wilczyński
parent bbaff68bf4
commit e354bb84a4
No known key found for this signature in database
GPG Key ID: 7C64768D3DE334E7
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
drivers/pci/devres.c
View File

@ -510,7 +510,7 @@ static void pcim_iomap_release(struct device *gendev, void *res)
} }
/** /**
* pcim_iomap_table - access iomap allocation table * pcim_iomap_table - access iomap allocation table (DEPRECATED)
* @pdev: PCI device to access iomap table for * @pdev: PCI device to access iomap table for
* *
* Returns: * Returns:
@ -524,6 +524,11 @@ static void pcim_iomap_release(struct device *gendev, void *res)
* This function might sleep when the table is first allocated but can * This function might sleep when the table is first allocated but can
* be safely called without context and guaranteed to succeed once * be safely called without context and guaranteed to succeed once
* allocated. * allocated.
*
* This function is DEPRECATED. Do not use it in new code. Instead, obtain a
* mapping's address directly from one of the pcim_* mapping functions. For
* example:
* void __iomem \*mappy = pcim_iomap(pdev, bar, length);
*/ */
void __iomem * const *pcim_iomap_table(struct pci_dev *pdev) void __iomem * const *pcim_iomap_table(struct pci_dev *pdev)
{ {
@ -897,6 +902,7 @@ static int pcim_request_all_regions(struct pci_dev *pdev, const char *name)
/** /**
* pcim_iomap_regions_request_all - Request all BARs and iomap specified ones * pcim_iomap_regions_request_all - Request all BARs and iomap specified ones
* (DEPRECATED)
* @pdev: PCI device to map IO resources for * @pdev: PCI device to map IO resources for
* @mask: Mask of BARs to iomap * @mask: Mask of BARs to iomap
* @name: Name associated with the requests * @name: Name associated with the requests
@ -907,6 +913,10 @@ static int pcim_request_all_regions(struct pci_dev *pdev, const char *name)
* *
* To release these resources manually, call pcim_release_region() for the * To release these resources manually, call pcim_release_region() for the
* regions and pcim_iounmap() for the mappings. * regions and pcim_iounmap() for the mappings.
*
* This function is DEPRECATED. Don't use it in new code. Instead, use one
* of the pcim_* region request functions in combination with a pcim_*
* mapping function.
*/ */
int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask, int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
const char *name) const char *name)