aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/libmaple/api/dma.rst
diff options
context:
space:
mode:
authorbnewbold <bnewbold@robocracy.org>2015-05-28 00:26:43 -0700
committerbnewbold <bnewbold@robocracy.org>2015-05-28 00:28:06 -0700
commit5f27a9afd80f0f405c042c22f9d7e404ba61e2f2 (patch)
treefecf041ed3ee51a56a5b26142c1b0b97cb6289c3 /docs/source/libmaple/api/dma.rst
parent5ada40e35c157362f4d3e2c59677d6ea9b648069 (diff)
parent71ef6f46a797f739bf140df934f137d92d791abc (diff)
downloadlibrambutan-5f27a9afd80f0f405c042c22f9d7e404ba61e2f2.tar.gz
librambutan-5f27a9afd80f0f405c042c22f9d7e404ba61e2f2.zip
Merge branch 'legacy'
- superficial rebranding to librambutan - bugfixes to documentation syntax
Diffstat (limited to 'docs/source/libmaple/api/dma.rst')
-rw-r--r--docs/source/libmaple/api/dma.rst10
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/source/libmaple/api/dma.rst b/docs/source/libmaple/api/dma.rst
index 286b6d6..4ce298d 100644
--- a/docs/source/libmaple/api/dma.rst
+++ b/docs/source/libmaple/api/dma.rst
@@ -34,6 +34,10 @@ Devices
Functions
---------
+.. NB: Some of these functions have multiple definitions, in which case the
+ complete function signature needs to be specified to disambiguate or breathe
+ will choke ("Unable to resolve multiple matches for function"...)
+
.. doxygenfunction:: dma_init
.. doxygenfunction:: dma_setup_transfer
.. doxygenfunction:: dma_set_num_transfers
@@ -43,12 +47,12 @@ Functions
.. doxygenfunction:: dma_get_irq_cause
.. doxygenfunction:: dma_enable
.. doxygenfunction:: dma_disable
-.. doxygenfunction:: dma_set_mem_addr
+.. doxygenfunction:: dma_set_mem_addr(dma_dev *, dma_tube, __io void *)
.. doxygenfunction:: dma_set_per_addr
.. doxygendefine:: dma_channel_regs
.. doxygendefine:: dma_is_channel_enabled
-.. doxygenfunction:: dma_get_isr_bits
-.. doxygenfunction:: dma_clear_isr_bits
+.. doxygenfunction:: dma_get_isr_bits(dma_dev *, dma_tube)
+.. doxygenfunction:: dma_clear_isr_bits(dma_dev *, dma_tube)
Register Map Base Pointers
--------------------------