hw: add optional iDMA

Author: thommythomaso

Bender.local

@@ -7,3 +7,4 @@ overrides:
   ibex: { path: "rtl/ibex" }
   obi: { path: "rtl/obi" }
   riscv-dbg: { path: "rtl/riscv-dbg" }
+  idma: { path: "rtl/idma" }

Bender.lock

@@ -26,6 +26,14 @@ packages:
     source:
       Path: rtl/cve2
     dependencies: []
+  idma:
+    revision: null
+    version: null
+    source:
+      Path: rtl/idma
+    dependencies:
+    - common_cells
+    - obi
   obi:
     revision: null
     version: null

Bender.yml

@@ -16,6 +16,7 @@ dependencies:
   apb:                  { git: "https://github.com/pulp-platform/apb.git",                  version: 0.2.4  }
   obi:                  { git: "https://github.com/pulp-platform/obi.git",                  rev: 6a724da    } # 0.1.7+
   obi_peripherals:      { git: "https://github.com/pulp-platform/obi_peripherals.git",      rev: 21ee04d    } # UART
+  idma:                 { git: "https://github.com/pulp-platform/idma.git",                 rev: 80fdfa9    } # TODO: update
   cve2:                 { path: "rtl/cve2" } # a vendor package (no Bender.yml), see below 
 
 
@@ -133,6 +134,29 @@ vendor_package:
       - { from: 'Bender.yml',     to: 'Bender.yml',   patch_dir: '' }
       - { from: 'README.md',      to: 'README.md',    patch_dir: '' }
 
+#  - name: idma
+#    target_dir: rtl/idma
+#    upstream: { git: "https://github.com/pulp-platform/iDMA.git", rev: "80fdfa93cb56c092c829fd055dc9102a1c7070fa" } # TODO: fix once merged into master
+#    patch_dir: "rtl/.patches/idma"
+#    mapping:
+#      - { from: 'target/rtl/include/idma/tracer.svh', to: 'include/idma/tracer.svh',   patch_dir: 'include/idma' }
+#      - { from: 'target/rtl/idma_backend_rw_obi.sv', to: 'idma_backend_rw_obi.sv',   patch_dir: '' }
+#      - { from: 'target/rtl/idma_legalizer_rw_obi.sv', to: 'idma_legalizer_rw_obi.sv',   patch_dir: '' }
+#      - { from: 'src/backend/idma_legalizer_page_splitter.sv', to: 'idma_legalizer_page_splitter.sv',   patch_dir: '' }
+#      - { from: 'target/rtl/idma_transport_layer_rw_obi.sv', to: 'idma_transport_layer_rw_obi.sv',   patch_dir: '' }
+#      - { from: 'src/backend/idma_channel_coupler.sv', to: 'idma_channel_coupler.sv',   patch_dir: '' }
+#      - { from: 'src/backend/idma_dataflow_element.sv', to: 'idma_dataflow_element.sv',   patch_dir: '' }
+#      - { from: 'src/backend/idma_obi_read.sv', to: 'idma_obi_read.sv',   patch_dir: '' }
+#      - { from: 'src/backend/idma_obi_write.sv', to: 'idma_obi_write.sv',   patch_dir: '' }
+#      - { from: 'src/frontend/idma_transfer_id_gen.sv', to: 'idma_transfer_id_gen.sv',   patch_dir: '' }
+#      - { from: 'src/include/idma/guard.svh', to: 'include/idma/guard.svh',   patch_dir: 'include/idma' }
+#      - { from: 'src/include/idma/typedef.svh', to: 'include/idma/typedef.svh',   patch_dir: 'include/idma' }
+#      - { from: 'src/midend/idma_nd_midend.sv', to: 'idma_nd_midend.sv',   patch_dir: '' }
+#      - { from: 'src/idma_pkg.sv', to: 'idma_pkg.sv',   patch_dir: '' }
+#      - { from: 'Bender.yml', to: 'Bender.yml',   patch_dir: '' }
+#      - { from: 'README.md', to: 'README.md',   patch_dir: '' }
+#      - { from: 'CHANGELOG.md', to: 'CHANGELOG.md',   patch_dir: '' }
+
 
   ###############
   # peripherals #

README.md

@@ -30,8 +30,9 @@ The main SoC configurations are in `rtl/croc_pkg.sv`:
 | Parameter           | Default          | Function                                              |
 |---------------------|------------------|-------------------------------------------------------|
 | `PulpJtagIdCode`    | `32'hED9_C0C50`  | Debug module ID code                                  |
-| `SramBankNumWords`  | `512`            | Number of 32bit words in a memory bank                |
+| `iDMAEnable`        | `0`              | Enable optional DMA (see `rtl/idma`)                  |
 | `NumSramBanks`      | `2`              | Number of memory banks                                |
+| `SramBankNumWords`  | `512`            | Number of 32bit words in a memory bank                |
 | `BootAddr`          | `32'h1000_0000`  | Default boot address set in 'soc_ctrl' register       |
 | `croc_addr_map`     | see 'Memory Map' | Routing rules used for the main crossbar              |
 | `periph_addr_map`   | see 'Memory Map' | Routing rules used for the peripheral demuliplexer    |
@@ -60,6 +61,7 @@ The address map of the default configuration is as follows:
 | `32'h0300_2000` | `32'h0300_3000` | UART peripheral                            |
 | `32'h0300_5000` | `32'h0300_6000` | GPIO peripheral                            |
 | `32'h0300_A000` | `32'h0300_B000` | Timer peripheral                           |
+| `32'h0300_B000` | `32'h0300_C000` | (optional) DMA configuration               |
 | `32'h1000_0000` | `+SRAM_SIZE`    | Memory banks (SRAM)                        |
 | `32'h2000_0000` | `32'h8000_0000` | Passthrough to user domain                 |
 | `32'h2000_0000` | `32'h2000_1000` | reserved for string formatted user ROM*    |
@@ -86,9 +88,8 @@ graph LR;
 Currently, the final GDS is still missing the following things:
 
 - metal density fill
-- sealring
 
-These can be added in KLayout, check the [IHP repository](https://github.com/IHP-GmbH/IHP-Open-PDK/tree/main) (possible the dev branch) for a reference script.
+These can be done in KLayout, check the [IHP repository](https://github.com/IHP-GmbH/IHP-Open-PDK/tree/main) for a reference script.
 
 ### Example Results