summaryrefslogtreecommitdiffstats
path: root/Documentation/driver-api/dmaengine
Commit message (Collapse)AuthorAgeFilesLines
* dmaengine: doc: Properly indent metadata titleVinod Koul2020-01-281-2/+2
| | | | | | | | | | | | | | | | | | The newly added metadata documentation title was not properly indented resulting in doc build break: Sphinx parallel build error: docutils.utils.SystemMessage: /linux/Documentation/driver-api/dmaengine/client.rst:155: (SEVERE/4) Unexpected section title. Optional: per descriptor metadata --------------------------------- Fix this by doing the right indent Reported-by: Michael Ellerman <mpe@ellerman.id.au> Fixes: 7d083ae98357 ("dmaengine: doc: Add sections for per descriptor metadata support") Link: https://lore.kernel.org/r/20200128125032.1650816-1-vkoul@kernel.org Signed-off-by: Vinod Koul <vkoul@kernel.org>
* dmaengine: doc: Add sections for per descriptor metadata supportPeter Ujfalusi2020-01-212-0/+135
| | | | | | | | | | | | Update the provider and client documentation with details about the metadata support. Signed-off-by: Peter Ujfalusi <peter.ujfalusi@ti.com> Reviewed-by: Tero Kristo <t-kristo@ti.com> Tested-by: Keerthy <j-keerthy@ti.com> Reviewed-by: Grygorii Strashko <grygorii.strashko@ti.com> Link: https://lore.kernel.org/r/20191223110458.30766-4-peter.ujfalusi@ti.com Signed-off-by: Vinod Koul <vkoul@kernel.org>
* docs: index.rst: don't use genindex for pdf outputMauro Carvalho Chehab2019-07-311-1/+1
| | | | | | | | | The genindex logic is meant to be used only for html output, as pdf build has its own way to generate indexes. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Vinod Koul <vkoul@kernel.org> # dmaengine and soundwire Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: dmaengine: clean up description of dmatest usageHook, Gary2019-07-051-8/+13
| | | | | | | | | | Fix the formatting of the multi-channel test usage example. Call out the note about parameter ordering and add detail on the settings of parameters for the new version of dmatest. Fixes: f80f9988a26d7 ("dmaengine: Documentation: Add documentation for multi chan testing") Signed-off-by: Gary R Hook <gary.hook@amd.com> Signed-off-by: Vinod Koul <vkoul@kernel.org>
* Documentation :dmaengine: clarify DMA desc. pointer after submissionFederico Vaga2019-02-111-0/+7
| | | | | | | | It clarifies that the DMA description pointer returned by `dmaengine_prep_*` function should not be used after submission. Signed-off-by: Federico Vaga <federico.vaga@cern.ch> Signed-off-by: Vinod Koul <vkoul@kernel.org>
* Documentation: dmaengine: fix dmatest.rst warningRandy Dunlap2019-02-111-0/+1
| | | | | | | | | | Fix markup warning: insert a blank line before the hint. Documentation/driver-api/dmaengine/dmatest.rst:63: WARNING: Unexpected indentation. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Signed-off-by: Vinod Koul <vkoul@kernel.org>
* Merge tag 'dmaengine-4.21-rc1' of git://git.infradead.org/users/vkoul/slave-dmaLinus Torvalds2019-01-011-6/+103
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Pull dmaengine updates from Vinod Koul: "This includes a new driver, removes R-Mobile APE6 as it is no longer used, sprd cyclic dma support, last batch of dma_slave_config direction removal and random updates to bunch of drivers. Summary: - New driver for UniPhier MIO DMA controller - Remove R-Mobile APE6 support - Sprd driver updates and support for cyclic link-list - Remove dma_slave_config direction usage from rest of drivers - Minor updates to dmatest, dw-dmac, zynqmp and bcm dma drivers" * tag 'dmaengine-4.21-rc1' of git://git.infradead.org/users/vkoul/slave-dma: (48 commits) dmaengine: qcom_hidma: convert to DEFINE_SHOW_ATTRIBUTE dmaengine: pxa: remove DBGFS_FUNC_DECL() dmaengine: mic_x100_dma: convert to DEFINE_SHOW_ATTRIBUTE dmaengine: amba-pl08x: convert to DEFINE_SHOW_ATTRIBUTE dmaengine: Documentation: Add documentation for multi chan testing dmaengine: dmatest: Add transfer_size parameter dmaengine: dmatest: Add alignment parameter dmaengine: dmatest: Use fixed point div to calculate iops dmaengine: dmatest: Add support for multi channel testing dmaengine: rcar-dmac: Document R8A774C0 bindings dt-bindings: dmaengine: usb-dmac: Add binding for r8a774c0 dmaengine: zynqmp_dma: replace spin_lock_bh with spin_lock_irqsave dmaengine: sprd: Add me as one of the module authors dmaengine: sprd: Support DMA 2-stage transfer mode dmaengine: sprd: Support DMA link-list cyclic callback dmaengine: sprd: Set cur_desc as NULL when free or terminate one dma channel dmaengine: sprd: Fix the last link-list configuration dmaengine: sprd: Get transfer residue depending on the transfer direction dmaengine: sprd: Remove direction usage from struct dma_slave_config dmaengine: dmatest: fix a small memory leak in dmatest_func() ...
| * dmaengine: Documentation: Add documentation for multi chan testingSeraj Alijan2018-12-171-6/+103
| | | | | | | | | | | | | | Modify documentation to add multi channel testing support. Signed-off-by: Seraj Alijan <seraj.alijan@sondrel.com> Signed-off-by: Vinod Koul <vkoul@kernel.org>
* | dmaengine: Add mailing list address to the documentationAndy Shevchenko2018-11-201-0/+4
|/ | | | | | | | | | | It's not the first time I've got a private email in regard to dmatest.c module. Motivate people, by adding a note, to send their questions to the mailing list instead Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* dmaengine: Fix spelling for parenthesis in dmatest documentationAndy Shevchenko2018-03-261-4/+5
| | | | | | | | Fix spelling for parenthesis in dmatest documentation. Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> [ jc: did s/parenthesis/parentheses/ and reflowed ] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* dmaengine: Make dmatest.rst indeed reST compatibleAndy Shevchenko2018-03-261-14/+12
| | | | | | | | Make dmatest.rst indeed reST compatible. Achieve this by fixing several formatting issues. Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* dmaengine: Add note to dmatest documentation about supported channelsAndy Shevchenko2018-03-261-0/+5
| | | | | | | | | | | | The documentation is not so clear for newbies in a sense of what type of the channels are supported by it. Clarify this by adding a note at the preamble of the documentation. Reported-by: "Zhu, Tony" <tony.zhu@intel.com> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> Acked-By: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge tag 'dmaengine-4.16-rc1' of git://git.infradead.org/users/vkoul/slave-dmaLinus Torvalds2018-01-311-21/+17
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Pull dmaengine updates from Vinod Koul: "This time is smallish update with updates mainly to drivers: - updates to xilinx and zynqmp dma controllers - update reside calculation for rcar controller - more RSTify fixes for documentation - add support for race free transfer termination and updating for users for that - support for new rev of hidma with addition new APIs to get device match data in ACPI/OF - random updates to bunch of other drivers" * tag 'dmaengine-4.16-rc1' of git://git.infradead.org/users/vkoul/slave-dma: (47 commits) dmaengine: dmatest: fix container_of member in dmatest_callback dmaengine: stm32-dmamux: Remove unnecessary platform_get_resource() error check dmaengine: sprd: statify 'sprd_dma_prep_dma_memcpy' dmaengine: qcom_hidma: simplify DT resource parsing dmaengine: xilinx_dma: Free BD consistent memory dmaengine: xilinx_dma: Fix warning variable prev set but not used dmaengine: xilinx_dma: properly configure the SG mode bit in the driver for cdma dmaengine: doc: format struct fields using monospace dmaengine: doc: fix bullet list formatting dmaengine: ti-dma-crossbar: Fix event mapping for TPCC_EVT_MUX_60_63 dmaengine: cppi41: Fix channel queues array size check dmaengine: imx-sdma: Add MODULE_FIRMWARE dmaengine: xilinx_dma: Fix typos dmaengine: xilinx_dma: Differentiate probe based on the ip type dmaengine: xilinx_dma: fix style issues from checkpatch dmaengine: xilinx_dma: Fix kernel doc warnings dmaengine: xilinx_dma: Fix race condition in the driver for multiple descriptor scenario dmaeninge: xilinx_dma: Fix bug in multiple frame stores scenario in vdma dmaengine: xilinx_dma: Check for channel idle state before submitting dma descriptor dmaengine: zynqmp_dma: Fix race condition in the probe ...
| * dmaengine: doc: format struct fields using monospaceLuca Ceresoli2018-01-081-6/+6
| | | | | | | | | | | | | | Monospace is more readable and is also used elsewhere in the docs. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Vinod Koul <vinod.koul@intel.com>
| * dmaengine: doc: fix bullet list formattingLuca Ceresoli2018-01-081-16/+12
| | | | | | | | | | | | | | | | | | | | | | | | The bullet list documenting the 'struct dma_device' fields has several nesting errors, making it render improperly. It also has incoherent formatting: some fields have a description in the same bullet, some in a sub-bullet. Fix both to have a correct and coherent formatting. Signed-off-by: Luca Ceresoli <luca@lucaceresoli.net> Signed-off-by: Vinod Koul <vinod.koul@intel.com>
* | dmaengine: doc : Fix warning "Title underline too short" while make xmldocsMasanari Iida2017-12-021-1/+1
|/ | | | | | | | | | | | | | This patch fix following warning during 'make xmldocs' Documentation/driver-api/dmaengine/client.rst:188: WARNING: Title underline too short. Further APIs: ------------ Signed-off-by: Masanari Iida <standby24x7@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* dmaengine: doc: ReSTize pxa_dma docVinod Koul2017-11-052-0/+200
| | | | | | | | This converts and moves pxa_dma file with some format changes for RST style Signed-off-by: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* dmaengine: doc: ReSTize dmatest docVinod Koul2017-11-052-0/+120
| | | | | | | | This converts and moves dmatest file with some format changes for RST style Signed-off-by: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* dmaengine: doc: ReSTize client API docVinod Koul2017-11-052-0/+286
| | | | | | | | This converts and moves client API file with some format changes for RST style Signed-off-by: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* dmaengine: doc: ReSTize provider docVinod Koul2017-11-052-0/+519
| | | | | | | | This moves and converts provider file with some format changes for RST style Signed-off-by: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* dmaengine: doc: Add ReST style dmaengine documentVinod Koul2017-11-051-0/+13
This removes the index file and adds the index.rst as placeholder and update driver-api index to add dmaengine. As a consequence dmaengine documentation will be in driver-api/ Signed-off-by: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
OpenPOWER on IntegriCloud