iDMA: Update SoC DMA to newest version of iDMA (#26)

* iDMA: Update SoC-level dma * hw: Fix typo in iDMA integration * snitch_cluster: Bump to include iDMA update * target: Do not delete lock file on `bender-clean` * target: Remove Verilator Make targets * Bender.yml: Rename `snitch_cluster` target Due to collision with iDMA `snitch_cluster` target, which groups necessary iDMA sources for Snitch-cluster-based systems, we need a different group for sources specific to the Snitch cluster simulation target, which are not needed by Snitch-cluster-based systems. Thus, we rename `snitch_cluster` to `snitch_cluster_sim`. * hw: Fix iDMA integration * target: Update `sys_dma` C library functions based on iDMA * sw: Add system DMA test * target: Update trace generation * target: Replace `LOGS_DIR` with `SIM_DIR` * target: Fix bootrom Make targets --------- Co-authored-by: Thomas Benz <[email protected]>
pulp-platform · Sep 2, 2024 · d5d0d83 · d5d0d83
1 parent b17ffcf
commit d5d0d83
Show file tree

Hide file tree

Showing 14 changed files with 313 additions and 248 deletions.
diff --git a/Bender.local b/Bender.local
@@ -3,6 +3,6 @@
 # SPDX-License-Identifier: Apache-2.0
 
 overrides:
-  axi:                { git: https://github.com/pulp-platform/axi.git,                version: 0.39.0-beta.4 }
+  axi:                { git: https://github.com/pulp-platform/axi.git,                version: 0.39.2 }
   common_cells:       { git: https://github.com/pulp-platform/common_cells.git,       version: 1.31.1 }
   register_interface: { git: https://github.com/pulp-platform/register_interface.git, version: 0.4.2 }
diff --git a/Bender.lock b/Bender.lock
@@ -36,6 +36,13 @@ packages:
     - axi
     - common_cells
     - common_verification
+  axi_stream:
+    revision: 54891ff40455ca94a37641b9da4604647878cc07
+    version: 0.1.1
+    source:
+      Git: https://github.com/pulp-platform/axi_stream.git
+    dependencies:
+    - common_cells
   axi_tlb:
     revision: null
     version: null
@@ -103,6 +110,26 @@ packages:
       Git: https://github.com/pulp-platform/fpu_div_sqrt_mvp.git
     dependencies:
     - common_cells
+  idma:
+    revision: c12caf59bb482fe44b27361f6924ad346b2d22fe
+    version: 0.6.3
+    source:
+      Git: https://github.com/pulp-platform/iDMA
+    dependencies:
+    - axi
+    - axi_stream
+    - common_cells
+    - common_verification
+    - obi
+    - register_interface
+  obi:
+    revision: 5321106817e177d6c16ecc4daa922b96b1bc946b
+    version: 0.1.5
+    source:
+      Git: https://github.com/pulp-platform/obi.git
+    dependencies:
+    - common_cells
+    - common_verification
   opentitan_peripherals:
     revision: null
     version: null
@@ -136,7 +163,7 @@ packages:
       Git: https://github.com/pulp-platform/scm.git
     dependencies: []
   snitch_cluster:
-    revision: 269830af872fa943d8b079470120d42d62e1cb69
+    revision: da57b043dfe0ba563a55a9d83bf362873c713648
     version: null
     source:
       Git: https://github.com/pulp-platform/snitch_cluster.git
@@ -146,6 +173,7 @@ packages:
     - cluster_icache
     - common_cells
     - fpnew
+    - idma
     - register_interface
     - riscv-dbg
     - tech_cells_generic

diff --git a/Bender.yml b/Bender.yml
@@ -22,16 +22,17 @@ dependencies:
   apb:                    { git:  https://github.com/pulp-platform/apb.git,                version: 0.2.0 }
   apb_timer:              { git:  https://github.com/pulp-platform/apb_timer.git,          rev:     0cbc6cbc26c94b8e3bf27cc058c48ef89ea3d4c3 }
   apb_uart:               { git:  https://github.com/pulp-platform/apb_uart.git,           rev:     b6145341df79137ac584c83e9c081f80a7a40440 }
-  axi:                    { git:  https://github.com/pulp-platform/axi.git,                version: 0.39.0  }
+  axi:                    { git:  https://github.com/pulp-platform/axi.git,                version: 0.39.2  }
   axi_tlb:                { path: hw/vendor/pulp_platform_axi_tlb                                           }
   clint:                  { git:  https://github.com/pulp-platform/clint.git,              rev:     v0.1.0  }
   common_cells:           { git:  https://github.com/pulp-platform/common_cells.git,       rev:     v1.28.0 }
   cva6:                   { path: hw/vendor/openhwgroup_cva6                                                }
   opentitan_peripherals:  { path: hw/vendor/pulp_platform_opentitan_peripherals                             }
-  register_interface:     { git:  https://github.com/pulp-platform/register_interface.git, version: 0.3.8   }
-  snitch_cluster:         { git:  https://github.com/pulp-platform/snitch_cluster.git,     rev:     269830af872fa943d8b079470120d42d62e1cb69 }
+  register_interface:     { git:  https://github.com/pulp-platform/register_interface.git, version: 0.4.2   }
+  snitch_cluster:         { git:  https://github.com/pulp-platform/snitch_cluster.git,     rev:     occamy  }
   tech_cells_generic:     { git:  https://github.com/pulp-platform/tech_cells_generic.git, rev:     v0.2.11 }
   cluster_icache:         { git:  https://github.com/pulp-platform/cluster_icache.git,     version: 0.1.0   }
+  idma:                   { git:  https://github.com/pulp-platform/iDMA,                   version: 0.6.0   }
 
 workspace:
   package_links:
@@ -60,14 +61,14 @@ sources:
       - hw/spm_interface/test/tb_spm_1p_adv.sv
 
   # soc_ctrl
-  - target: occamy
+  - target: occamy_sim
     files:
       - target/sim/src/soc_ctrl/occamy_soc_reg_pkg.sv
       - target/sim/src/soc_ctrl/occamy_soc_reg_top.sv
   - hw/occamy/soc_ctrl/occamy_soc_ctrl.sv
 
   # auto-generated soc
-  - target: occamy
+  - target: occamy_sim
     files:
       # quadrant_s1_ctrl
       - target/sim/src/quadrant_s1_ctrl/occamy_quadrant_s1_reg_pkg.sv

diff --git a/hw/occamy/occamy_soc.sv.tpl b/hw/occamy/occamy_soc.sv.tpl
@@ -43,6 +43,7 @@
 `include "common_cells/registers.svh"
 `include "register_interface/typedef.svh"
 `include "axi/assign.svh"
+`include "idma/typedef.svh"
 
 module ${name}_soc
   import ${name}_pkg::*;
@@ -408,35 +409,73 @@ module ${name}_soc
 
   <% out_sys_idma_cfg = soc_narrow_xbar.__dict__["out_sys_idma_cfg"] \
   .atomic_adapter(context, filter=True, max_trans=max_trans_atop_filter_per, name="out_sys_idma_cfg_noatop", inst_name="i_out_sys_idma_cfg_atop_filter") \
+  .change_dw(context, 32, "out_sys_idma_cfg_dw") \
   %>\
 
-  // .change_dw(context, 32, "out_sys_idma_cfg_dw") \
+  // iDMA master AXI bus
+  <% 
+  in_sys_idma_mst = soc_wide_xbar.__dict__["in_sys_idma_mst"].copy(name="sys_idma_mst")
+  in_sys_idma_mst.uw = 1
+  in_sys_idma_mst.type_prefix = in_sys_idma_mst.emit_struct()
+  in_sys_idma_mst.declare(context)
+  in_sys_idma_mst.change_uw(context, soc_wide_xbar.__dict__["in_sys_idma_mst"].uw, "", to=soc_wide_xbar.__dict__["in_sys_idma_mst"])
+  %>\
+
+  // local regbus definition
+  `REG_BUS_TYPEDEF_ALL(idma_cfg_reg_a${wide_in.aw}_d32, logic [${wide_in.aw-1}:0], logic [31:0], logic [7:0])
+
+  // iDMA types
+  localparam int unsigned iDMAStrbWidth = ${wide_in.dw} / 32'd8;
+  localparam int unsigned iDMAOffsetWidth = $clog2(iDMAStrbWidth);
+  localparam type idma_addr_t = logic[${wide_in.aw-1}:0];
+  localparam type idma_id_t = logic[${wide_in.iw-1}:0];
+  localparam type idma_tf_len_t = logic[${wide_in.aw-1}:0];
+  localparam type idma_tf_id_t = logic[31:0];
+
+  // iDMA backend types
+  `IDMA_TYPEDEF_OPTIONS_T(options_t, idma_id_t)
+  `IDMA_TYPEDEF_REQ_T(idma_req_t, idma_tf_len_t, idma_addr_t, options_t)
+  `IDMA_TYPEDEF_ERR_PAYLOAD_T(err_payload_t, idma_addr_t)
+  `IDMA_TYPEDEF_RSP_T(idma_rsp_t, err_payload_t)
+
+  // AXI meta channels
+  typedef struct packed {
+    ${in_sys_idma_mst.ar_chan_type()} ar_chan;
+  } axi_read_meta_channel_t;
 
-  <% in_sys_idma_mst  = soc_wide_xbar.__dict__["in_sys_idma_mst"] %>\
+  typedef struct packed {
+    axi_read_meta_channel_t axi;
+  } read_meta_channel_t;
 
-  // burst request
   typedef struct packed {
-    logic [${wide_in.iw-1}:0] id;
-    logic [${wide_in.aw-1}:0] src, dst;
-    logic [${wide_in.aw-1}:0] num_bytes;
-    axi_pkg::cache_t    cache_src, cache_dst;
-    axi_pkg::burst_t    burst_src, burst_dst;
-    logic               decouple_rw;
-    logic               deburst;
-    logic               serialize;
-  } idma_burst_req_t;
+    ${in_sys_idma_mst.aw_chan_type()} aw_chan;
+  } axi_write_meta_channel_t;
 
-  // local regbus definition
-  `REG_BUS_TYPEDEF_ALL(idma_cfg_reg_a${wide_in.aw}_d64, logic [${wide_in.aw-1}:0], logic [63:0], logic [7:0])
+  typedef struct packed {
+    axi_write_meta_channel_t axi;
+  } write_meta_channel_t;
+
+  // internal AXI channels
+  ${in_sys_idma_mst.req_type()} idma_axi_read_req, idma_axi_write_req;
+  ${in_sys_idma_mst.rsp_type()} idma_axi_read_rsp, idma_axi_write_rsp;
+
+  // backend signals
+  idma_req_t idma_req, idma_req_fe;
+  logic idma_req_valid, idma_req_fe_valid;
+  logic idma_req_ready, idma_req_fe_ready;
 
-  idma_burst_req_t idma_burst_req;
-  logic idma_be_valid;
-  logic idma_be_ready;
-  logic idma_be_idle;
-  logic idma_be_trans_complete;
+  // counter signals
+  logic idma_issue_id;
+  logic idma_retire_id;
+  idma_tf_id_t idma_next_id;
+  idma_tf_id_t idma_completed_id;
 
-  idma_cfg_reg_a${wide_in.aw}_d64_req_t idma_cfg_reg_req;
-  idma_cfg_reg_a${wide_in.aw}_d64_rsp_t idma_cfg_reg_rsp;
+  // busy signals
+  idma_pkg::idma_busy_t idma_busy;
+
+  // Regbus instance
+  idma_cfg_reg_a${out_sys_idma_cfg.aw}_d32_req_t idma_cfg_reg_req;
+  idma_cfg_reg_a${out_sys_idma_cfg.aw}_d32_rsp_t idma_cfg_reg_rsp;
 
   axi_to_reg #(
     .ADDR_WIDTH( ${out_sys_idma_cfg.aw}                 ),
@@ -445,8 +484,8 @@ module ${name}_soc
     .USER_WIDTH( ${out_sys_idma_cfg.uw}                 ),
     .axi_req_t ( ${out_sys_idma_cfg.req_type()}         ),
     .axi_rsp_t ( ${out_sys_idma_cfg.rsp_type()}         ),
-    .reg_req_t ( idma_cfg_reg_a${wide_in.aw}_d64_req_t  ),
-    .reg_rsp_t ( idma_cfg_reg_a${wide_in.aw}_d64_rsp_t  )
+    .reg_req_t ( idma_cfg_reg_a${out_sys_idma_cfg.aw}_d32_req_t  ),
+    .reg_rsp_t ( idma_cfg_reg_a${out_sys_idma_cfg.aw}_d32_rsp_t  )
   ) i_axi_to_reg_sys_idma_cfg (
     .clk_i,
     .rst_ni,
@@ -457,48 +496,118 @@ module ${name}_soc
     .reg_rsp_i  ( idma_cfg_reg_rsp               )
   );
 
-  idma_reg64_frontend #(
-    .DmaAddrWidth    ( 'd64                                  ),
-    .dma_regs_req_t  ( idma_cfg_reg_a${wide_in.aw}_d64_req_t ),
-    .dma_regs_rsp_t  ( idma_cfg_reg_a${wide_in.aw}_d64_rsp_t ),
-    .burst_req_t     ( idma_burst_req_t                      )
-  ) i_idma_reg64_frontend_sys_idma (
+  idma_reg64_1d # (
+    .NumRegs        ( 32'd1 ),
+    .NumStreams     ( 32'd1 ),
+    .IdCounterWidth ( 32'd32 ),
+    .reg_req_t      ( idma_cfg_reg_a${out_sys_idma_cfg.aw}_d32_req_t ),
+    .reg_rsp_t      ( idma_cfg_reg_a${out_sys_idma_cfg.aw}_d32_rsp_t ),
+    .dma_req_t      ( idma_req_t )
+  ) i_idma_reg64_1d (
     .clk_i,
     .rst_ni,
-    .dma_ctrl_req_i   ( idma_cfg_reg_req       ),
-    .dma_ctrl_rsp_o   ( idma_cfg_reg_rsp       ),
-    .burst_req_o      ( idma_burst_req         ),
-    .valid_o          ( idma_be_valid          ),
-    .ready_i          ( idma_be_ready          ),
-    .backend_idle_i   ( idma_be_idle           ),
-    .trans_complete_i ( idma_be_trans_complete )
+    .dma_ctrl_req_i ( idma_cfg_reg_req ),
+    .dma_ctrl_rsp_o ( idma_cfg_reg_rsp ),
+    .dma_req_o      ( idma_req_fe ),
+    .req_valid_o    ( idma_req_fe_valid ),
+    .req_ready_i    ( idma_req_fe_ready ),
+    .next_id_i      ( idma_next_id ),
+    .stream_idx_o   ( /* NOT CONNECTED */ ),
+    .done_id_i      ( idma_completed_id ),
+    .busy_i         ( idma_busy ),
+    .midend_busy_i  ( 1'b0 )
   );
 
-  axi_dma_backend #(
-    .DataWidth      ( ${in_sys_idma_mst.dw}         ),
-    .AddrWidth      ( ${in_sys_idma_mst.aw}         ),
-    .IdWidth        ( ${in_sys_idma_mst.iw}         ),
-    .AxReqFifoDepth ( 'd64                          ),
-    .TransFifoDepth ( 'd16                          ),
-    .BufferDepth    ( 'd3                           ),
-    .axi_req_t      ( ${in_sys_idma_mst.req_type()} ),
-    .axi_res_t      ( ${in_sys_idma_mst.rsp_type()} ),
-    .burst_req_t    ( idma_burst_req_t              ),
-    .DmaIdWidth     ( 'd32                          ),
-    .DmaTracing     ( 1'b1                          )
-  ) i_axi_dma_backend_sys_idma (
+  stream_fifo_optimal_wrap #(
+    .Depth     ( 32'd16 ),
+    .type_t    ( idma_req_t ),
+    .PrintInfo ( 1'b0 )
+  ) i_stream_fifo_optimal_wrap (
     .clk_i,
     .rst_ni,
-    .dma_id_i         ( 'd0                           ),
-    .axi_dma_req_o    ( ${in_sys_idma_mst.req_name()} ),
-    .axi_dma_res_i    ( ${in_sys_idma_mst.rsp_name()} ),
-    .burst_req_i      ( idma_burst_req                ),
-    .valid_i          ( idma_be_valid                 ),
-    .ready_o          ( idma_be_ready                 ),
-    .backend_idle_o   ( idma_be_idle                  ),
-    .trans_complete_o ( idma_be_trans_complete        )
+    .testmode_i ( test_mode_i ),
+    .flush_i    ( 1'b0 ),
+    .usage_o    ( /* NC */ ),
+    .data_i     ( idma_req_fe ),
+    .valid_i    ( idma_req_fe_valid ),
+    .ready_o    ( idma_req_fe_ready ),
+    .data_o     ( idma_req ),
+    .valid_o    ( idma_req_valid ),
+    .ready_i    ( idma_req_ready )
   );
 
+  idma_backend_rw_axi #(
+    .DataWidth            ( ${in_sys_idma_mst.dw} ),
+    .AddrWidth            ( ${in_sys_idma_mst.aw} ),
+    .UserWidth            ( ${in_sys_idma_mst.uw} ),
+    .AxiIdWidth           ( ${in_sys_idma_mst.iw} ),
+    .NumAxInFlight        ( 32'd64 ),
+    .BufferDepth          ( 32'd3 ),
+    .TFLenWidth           ( ${in_sys_idma_mst.aw} ),
+    .MemSysDepth          ( 32'd16 ),
+    .CombinedShifter      ( 1'b1 ),
+    .RAWCouplingAvail     ( 1'b1 ),
+    .MaskInvalidData      ( 1'b0 ),
+    .HardwareLegalizer    ( 1'b1 ),
+    .RejectZeroTransfers  ( 1'b1 ),
+    .ErrorCap             ( idma_pkg::NO_ERROR_HANDLING ),
+    .PrintFifoInfo        ( 1'b0 ),
+    .idma_req_t           ( idma_req_t ),
+    .idma_rsp_t           ( idma_rsp_t ),
+    .idma_eh_req_t        ( idma_pkg::idma_eh_req_t ),
+    .idma_busy_t          ( idma_pkg::idma_busy_t ),
+    .axi_req_t            ( ${in_sys_idma_mst.req_type()} ),
+    .axi_rsp_t            ( ${in_sys_idma_mst.rsp_type()} ),
+    .read_meta_channel_t  ( read_meta_channel_t ),
+    .write_meta_channel_t ( write_meta_channel_t )
+  ) i_idma_backend_rw_axi (
+    .clk_i,
+    .rst_ni,
+    .testmode_i      ( test_mode_i ),
+    .idma_req_i      ( idma_req ),
+    .req_valid_i     ( idma_req_valid ),
+    .req_ready_o     ( idma_req_ready ),
+    .idma_rsp_o      ( /* NC */ ),
+    .rsp_valid_o     ( idma_retire_id ),
+    .rsp_ready_i     ( 1'b1 ),
+    .idma_eh_req_i   ( '0 ),
+    .eh_req_valid_i  ( 1'b0 ),
+    .eh_req_ready_o  ( /* NC */ ),
+    .axi_read_req_o  ( idma_axi_read_req ),
+    .axi_read_rsp_i  ( idma_axi_read_rsp ),
+    .axi_write_req_o ( idma_axi_write_req ),
+    .axi_write_rsp_i ( idma_axi_write_rsp ),
+    .busy_o          ( idma_busy )
+  );
+
+  axi_rw_join #(
+    .axi_req_t  ( ${in_sys_idma_mst.req_type()} ),
+    .axi_resp_t ( ${in_sys_idma_mst.rsp_type()} )
+  ) i_axi_rw_join (
+    .clk_i,
+    .rst_ni,
+    .slv_read_req_i   ( idma_axi_read_req  ),
+    .slv_read_resp_o  ( idma_axi_read_rsp  ),
+    .slv_write_req_i  ( idma_axi_write_req ),
+    .slv_write_resp_o ( idma_axi_write_rsp ),
+    .mst_req_o        ( ${in_sys_idma_mst.req_name()} ),
+    .mst_resp_i       ( ${in_sys_idma_mst.rsp_name()} )
+  );
+
+  idma_transfer_id_gen #(
+    .IdWidth ( 32'd32 )
+  ) i_idma_transfer_id_gen (
+    .clk_i,
+    .rst_ni,
+    .issue_i     ( idma_issue_id ),
+    .retire_i    ( idma_retire_id ),
+    .next_o      ( idma_next_id ),
+    .completed_o ( idma_completed_id )
+  );
+
+  // issue ids
+  assign idma_issue_id = idma_req_valid & idma_req_ready;
+
   ///////////
   // HBM2e //
   ///////////

diff --git a/hw/occamy/occamy_top.sv.tpl b/hw/occamy/occamy_top.sv.tpl
@@ -409,15 +409,15 @@ module ${name}_top
 
   assign sba_addr = sba_addr_long[${regbus_debug.aw-1}:0];
 
-  mem_to_axi_lite #(
+  axi_lite_from_mem #(
     .MemAddrWidth (${regbus_debug.aw}),
     .AxiAddrWidth (${regbus_debug.aw}),
     .DataWidth (${regbus_debug.dw}),
     .MaxRequests (2),
     .AxiProt ('0),
     .axi_req_t (${soc_periph_xbar.in_debug.req_type()}),
     .axi_rsp_t (${soc_periph_xbar.in_debug.rsp_type()})
-  ) i_mem_to_axi_lite (
+  ) i_axi_lite_from_mem (
     .clk_i (${regbus_debug.clk}),
     .rst_ni (${regbus_debug.rst}),
     .mem_req_i (sba_req),