History

PCI/doc: cleanup references to the legacy PCI DMA API

Mention the regular DMA API calls instead of the now removed PCI DMA API.

Christoph Hellwig committed 4 years ago

Commit 05b0ebd1 parent 79687781 file · +7 −7Browse files

Unified · Split

Documentation/PCI/pci.rst+7−7
@@ -278,20 +278,20 @@ appropriate parameters. In general this allows more efficient DMA · 277 unmodified lines
278on systems where System RAM exists above 4G _physical_ address.278on systems where System RAM exists above 4G _physical_ address.
279 279
280Drivers for all PCI-X and PCIe compliant devices must call280Drivers for all PCI-X and PCIe compliant devices must call
281pci_set_dma_mask() as they are 64-bit DMA devices.281set_dma_mask() as they are 64-bit DMA devices.
282 282
283Similarly, drivers must also "register" this capability if the device283Similarly, drivers must also "register" this capability if the device
284can directly address "consistent memory" in System RAM above 4G physical284can directly address "coherent memory" in System RAM above 4G physical
285address by calling pci_set_consistent_dma_mask().285address by calling dma_set_coherent_mask().
286Again, this includes drivers for all PCI-X and PCIe compliant devices.286Again, this includes drivers for all PCI-X and PCIe compliant devices.
287Many 64-bit "PCI" devices (before PCI-X) and some PCI-X devices are287Many 64-bit "PCI" devices (before PCI-X) and some PCI-X devices are
28864-bit DMA capable for payload ("streaming") data but not control28864-bit DMA capable for payload ("streaming") data but not control
289("consistent") data.289("coherent") data.
290 290
291 291
292Setup shared control data292Setup shared control data
293-------------------------293-------------------------
294Once the DMA masks are set, the driver can allocate "consistent" (a.k.a. shared)294Once the DMA masks are set, the driver can allocate "coherent" (a.k.a. shared)
295memory. See Documentation/core-api/dma-api.rst for a full description of295memory. See Documentation/core-api/dma-api.rst for a full description of
296the DMA APIs. This section is just a reminder that it needs to be done296the DMA APIs. This section is just a reminder that it needs to be done
297before enabling DMA on the device.297before enabling DMA on the device.
@@ -367,7 +367,7 @@ steps need to be performed: · 69 unmodified lines
367 - Disable the device from generating IRQs367 - Disable the device from generating IRQs
368 - Release the IRQ (free_irq())368 - Release the IRQ (free_irq())
369 - Stop all DMA activity369 - Stop all DMA activity
370 - Release DMA buffers (both streaming and consistent)370 - Release DMA buffers (both streaming and coherent)
371 - Unregister from other subsystems (e.g. scsi or netdev)371 - Unregister from other subsystems (e.g. scsi or netdev)
372 - Disable device from responding to MMIO/IO Port addresses372 - Disable device from responding to MMIO/IO Port addresses
373 - Release MMIO/IO Port resource(s)373 - Release MMIO/IO Port resource(s)
@@ -420,7 +420,7 @@ Once DMA is stopped, clean up streaming DMA first. · 46 unmodified lines
420I.e. unmap data buffers and return buffers to "upstream"420I.e. unmap data buffers and return buffers to "upstream"
421owners if there is one.421owners if there is one.
422 422
423Then clean up "consistent" buffers which contain the control data.423Then clean up "coherent" buffers which contain the control data.
424 424
425See Documentation/core-api/dma-api.rst for details on unmapping interfaces.425See Documentation/core-api/dma-api.rst for details on unmapping interfaces.
426 426