Changes between Version 6 and Version 7 of Component/Vci Dma

Timestamp:

Feb 9, 2008, 7:04:30 PM (16 years ago)

Author:

alain

Comment:

--

Component/Vci Dma

@@ -1 +1 @@
 [wiki:Component SocLib Components General Index] 
 
-= !VciDma Functional Description =
+= !VciDma =
+
+== 1) Functional Description ==
 
 This VCI component is both a target and an initiator.
@@ -14 +16 @@
 as a default target.
 
-= Memory region layout =
+This component has 4 memory-mapped registers :
 
  * `DMA_SRC`
-The source of memory copy.
+The physical address of the source buffer.
 
  * `DMA_DST`
-The destination of memory copy
+The physical address of the destination buffer.
 
  * `DMA_LEN`
@@ -27 +29 @@
 
  * `DMA_IRQ_ENABLED`
-  * Written to: A boolean enabling the IRQ line (0 is disabling)
-  * Read from: A boolean indicating the completion of the transfer, (0 is completed)
-
-= Component usage =
+  * Writing a non zero value enables the IRQ line (0 is disabling)
+  * Reading a zero value indicates the completion of the transfer
 
 For extensibility issues, you should access the DMA using globally-defined offsets.
@@ -57 +57 @@
 (add -I/path/to/soclib/include to your compilation command-line)
 
-= Component definition =
+== 2) Component definition & usage ==
 
-Available in source:trunk/soclib/soclib/module/infrastructure_component/dma_infrastructure/vci_dma/caba/metadata/vci_dma.sd
+source:trunk/soclib/soclib/module/infrastructure_component/dma_infrastructure/vci_dma/caba/metadata/vci_dma.sd
 
-== Usage ==
-
-!VciDma has no other parameter than VCI ones, it may be used like others, see [wiki:SoclibCc/VciParameters SoclibCc/VciParameters]
+See [wiki:SoclibCc/VciParameters SoclibCc/VciParameters]
 {{{
 Uses( 'vci_dma', **vci_parameters )
 }}}
 
-= !VciDma CABA  Implementation =
+== 3) CABA  Implementation ==
 
-The caba implementation is in 
- * source:trunk/soclib/soclib/module/infrastructure_component/dma_infrastructure/vci_dma/caba/source/include/vci_dma.h
- * source:trunk/soclib/soclib/module/infrastructure_component/dma_infrastructure/vci_dma/caba/source/src/vci_dma.cpp
+=== CABA sources ===
+ 
+ * interface : source:trunk/soclib/soclib/module/infrastructure_component/dma_infrastructure/vci_dma/caba/source/include/vci_dma.h
+ * implementation : source:trunk/soclib/soclib/module/infrastructure_component/dma_infrastructure/vci_dma/caba/source/src/vci_dma.cpp
 
-== Template parameters: ==
-
- * The VCI parameters
-
-== Constructor parameters ==
+=== CABA Constructor parameters ===
 {{{
 VciDma(
@@ -87 +82 @@
 }}}
 
-== Ports ==
+===  CABA Ports ===
 
  * sc_in<bool> '''p_resetn''' : Global system reset
@@ -94 +89 @@
  * soclib::caba::!VciInitiator<vci_param> '''p_vci_initiator''' : The VCI initiator port
  * sc_out<bool> '''p_irq''' : Interrupt port
+
+== 4) TLM-T implementation ==
+
+The TLM-T implementation is not available yet.
+