linux/Documentation/driver-api
Lucas De Marchi 7938f42181 dma-buf-map: Rename to iosys-map
Rename struct dma_buf_map to struct iosys_map and corresponding APIs.
Over time dma-buf-map grew up to more functionality than the one used by
dma-buf: in fact it's just a shim layer to abstract system memory, that
can be accessed via regular load and store, from IO memory that needs to
be acessed via arch helpers.

The idea is to extend this API so it can fulfill other needs, internal
to a single driver. Example: in the i915 driver it's desired to share
the implementation for integrated graphics, which uses mostly system
memory, with discrete graphics, which may need to access IO memory.

The conversion was mostly done with the following semantic patch:

	@r1@
	@@
	- struct dma_buf_map
	+ struct iosys_map

	@r2@
	@@
	(
	- DMA_BUF_MAP_INIT_VADDR
	+ IOSYS_MAP_INIT_VADDR
	|
	- dma_buf_map_set_vaddr
	+ iosys_map_set_vaddr
	|
	- dma_buf_map_set_vaddr_iomem
	+ iosys_map_set_vaddr_iomem
	|
	- dma_buf_map_is_equal
	+ iosys_map_is_equal
	|
	- dma_buf_map_is_null
	+ iosys_map_is_null
	|
	- dma_buf_map_is_set
	+ iosys_map_is_set
	|
	- dma_buf_map_clear
	+ iosys_map_clear
	|
	- dma_buf_map_memcpy_to
	+ iosys_map_memcpy_to
	|
	- dma_buf_map_incr
	+ iosys_map_incr
	)

	@@
	@@
	- #include <linux/dma-buf-map.h>
	+ #include <linux/iosys-map.h>

Then some files had their includes adjusted and some comments were
update to remove mentions to dma-buf-map.

Since this is not specific to dma-buf anymore, move the documentation to
the "Bus-Independent Device Accesses" section.

v2:
  - Squash patches

v3:
  - Fix wrong removal of dma-buf.h from MAINTAINERS
  - Move documentation from dma-buf.rst to device-io.rst

v4:
  - Change documentation title and level

Signed-off-by: Lucas De Marchi <lucas.demarchi@intel.com>
Acked-by: Christian König <christian.koenig@amd.com>
Acked-by: Sumit Semwal <sumit.semwal@linaro.org>
Acked-by: Thomas Zimmermann <tzimmermann@suse.de>
Link: https://patchwork.freedesktop.org/patch/msgid/20220204170541.829227-1-lucas.demarchi@intel.com
2022-02-07 16:35:35 -08:00
..
80211
acpi Documentation: ACPI: fix error script name 2021-06-17 13:21:48 -06:00
backlight
cxl Documentation/cxl: Add bus internal docs 2021-09-21 14:18:49 -07:00
dmaengine Documentation: dmaengine: Correctly describe dmatest with channel unset 2021-11-22 12:31:00 +05:30
driver-model iio: inkern: introduce devm_iio_map_array_register() short-hand function 2021-10-19 08:27:34 +01:00
early-userspace Documentation: Fix intiramfs script name 2021-07-18 23:48:14 +09:00
firmware
fpga fpga: region: Use standard dev_release for class driver 2021-11-28 14:02:41 -08:00
gpio docs: gpio: explain GPIOD_OUT_* values and toggling active low 2021-07-21 15:21:36 +02:00
i3c
iio docs: iio: mark "repeat" sysfs attribute as optional 2021-03-11 20:47:08 +00:00
md
media media: drivers/index.rst: add missing rkisp1 entry 2021-11-15 08:12:04 +00:00
mei
memory-devices
mmc docs: mmc: update maintainer name and URL 2021-10-28 11:54:54 +02:00
mtd
nfc nfc: constify nfc_llc_ops 2021-07-25 09:21:21 +01:00
nvdimm MAINTAINERS: Move nvdimm mailing list 2021-05-12 12:37:15 -07:00
pci PCI/MSI: Move code into a separate directory 2021-12-09 11:52:22 +01:00
phy
pldmfw
pm docs: devices.rst: better reference documentation docs 2021-06-17 13:24:36 -06:00
rapidio
serial docs/driver-api: Replace a comma in the n_gsm.rst with a double colon 2021-12-21 10:18:36 +01:00
soundwire
surface_aggregator platform-drivers-x86 for v5.14-1 2021-06-30 11:15:39 -07:00
thermal thermal: Move ABI documentation to Documentation/ABI 2021-10-07 19:25:47 +02:00
usb Docs: usb: update writesize, copy_from_user, usb_fill_bulk_urb, usb_submit_urb 2021-11-17 14:54:58 +01:00
xilinx
auxiliary_bus.rst Documentation/auxiliary_bus: Move the text into the code 2021-12-03 16:41:50 +01:00
basics.rst
clk.rst
component.rst
connector.rst
console.rst
dcdbas.rst
devfreq.rst
device-io.rst dma-buf-map: Rename to iosys-map 2022-02-07 16:35:35 -08:00
device_link.rst
dma-buf.rst dma-buf-map: Rename to iosys-map 2022-02-07 16:35:35 -08:00
edac.rst
eisa.rst
firewire.rst Documentation: fix firewire.rst ABI file path error 2022-01-20 17:01:32 -07:00
frame-buffer.rst
generic-counter.rst counter: Update documentation for new counter registration functions 2021-12-30 17:44:06 +01:00
hsi.rst
i2c.rst
index.rst remove the lightnvm subsystem 2021-08-14 15:54:09 -06:00
infiniband.rst
infrastructure.rst
input.rst
interconnect.rst
io-mapping.rst
io_ordering.rst
ioctl.rst docs: driver-api: avoid using ReST :doc:foo markup 2021-06-17 13:24:37 -06:00
ipmb.rst
ipmi.rst ipmi: Add docs for the IPMI IPMB driver 2021-10-05 06:54:17 -05:00
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 docs/pinctrl: fix the reference to the u300 platform 2021-05-28 02:59:40 +02:00
pps.rst
ptp.rst
pwm.rst pwm: core: Remove unused devm_pwm_put() 2021-06-30 19:12:19 +02:00
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/mdev: Allow the mdev_parent_ops to specify the device driver to bind 2021-06-21 15:29:25 -06:00
vfio.rst vfio: Introduce a vfio_uninit_group_dev() API call 2021-08-11 09:50:10 -06:00
vme.rst
w1.rst
xillybus.rst
zorro.rst