Skip to content

Commit ee54456

Browse files
committedApr 30, 2024
docs: axi_dmac: Update documentation
Signed-off-by: Ionut Podgoreanu <ionut.podgoreanu@analog.com>
1 parent 107047e commit ee54456

File tree

2 files changed

+51
-3
lines changed

2 files changed

+51
-3
lines changed
 

‎docs/library/axi_dmac/index.rst

+19
Original file line numberDiff line numberDiff line change
@@ -670,6 +670,25 @@ flag signal. For the AXI-Streaming interface the synchronization flag is carried
670670
in ``s_axis_user[0]``. In both cases the synchronization flag is qualified by
671671
the same control signal as the data.
672672

673+
Cache Coherency
674+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
675+
676+
To enable Cache Coherency between the DMA and the CPU, the ``CACHE_COHERENT``
677+
HDL synthesis configuration parameter must be set.
678+
679+
Two additional parameters are used to configure the Cache Coherent transactions:
680+
681+
- ``AXI_AXCACHE`` sets the ARCACHE/AWCACHE AXI cache support signals;
682+
- ``AXI_AXPROT`` sets the ARPROT/AWPROT AXI access permission signals.
683+
684+
They are initially set to the following default values through ``CACHE_COHERENT``:
685+
686+
- ``AXI_AXCACHE`` = ``CACHE_COHERENT`` ? ``4'b1111`` : ``4'b0011``
687+
- ``AXI_AXPROT`` = ``CACHE_COHERENT`` ? ``3'b010`` : ``3'b000``
688+
689+
If Cache Coherency is enabled, the ``AXI_AXCACHE`` and ``AXI_AXPROT`` values can
690+
be changed to support systems with different caching policies.
691+
673692
Diagnostics interface
674693
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
675694

‎docs/regmap/adi_regmap_dmac.txt

+32-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ ENDTITLE
99
REG
1010
0x000
1111
VERSION
12-
Version of the peripheral. Follows semantic versioning. Current version 4.05.61.
12+
Version of the peripheral. Follows semantic versioning. Current version 4.05.62.
1313
ENDREG
1414

1515
FIELD
@@ -25,7 +25,7 @@ RO
2525
ENDFIELD
2626

2727
FIELD
28-
[7:0] 0x61
28+
[7:0] 0x62
2929
VERSION_PATCH
3030
RO
3131
ENDFIELD
@@ -80,7 +80,7 @@ ENDFIELD
8080

8181
REG
8282
0x004
83-
INTERFACE_DESCRIPTION
83+
INTERFACE_DESCRIPTION_1
8484
ENDREG
8585

8686
FIELD
@@ -123,6 +123,35 @@ ENDFIELD
123123
############################################################################################
124124
############################################################################################
125125

126+
REG
127+
0x005
128+
INTERFACE_DESCRIPTION_2
129+
ENDREG
130+
131+
FIELD
132+
[0] ''CACHE_COHERENT''
133+
CACHE_COHERENT
134+
R
135+
Value of ''CACHE_COHERENT'' parameter.(0 - Disabled, 1 - Enabled )
136+
ENDFIELD
137+
138+
FIELD
139+
[7:4] ''AXI_AXCACHE''
140+
AXI_AXCACHE
141+
R
142+
Value of ''AXI_AXCACHE'' parameter.
143+
ENDFIELD
144+
145+
FIELD
146+
[10:8] ''AXI_AXPROT''
147+
AXI_AXPROT
148+
R
149+
Value of ''AXI_AXPROT'' parameter.
150+
ENDFIELD
151+
152+
############################################################################################
153+
############################################################################################
154+
126155
REG
127156
0x020
128157
IRQ_MASK

0 commit comments

Comments
 (0)