Support AVALON_MM CSR hostpipe

Author: zibaiwan

include/acl.h

@@ -535,6 +535,13 @@ struct acl_hostpipe_mapping {
   bool is_write;
   unsigned pipe_width;
   unsigned pipe_depth;
+
+  // Matches the protocol_name enum in
+  // https://github.com/intel/llvm/blob/sycl/sycl/include/sycl/ext/intel/experimental/pipe_properties.hpp
+  // Set a default value in case it's missing.
+
+  int protocol = -1; // avalon_streaming = 0, avalon_streaming_uses_ready = 1
+                     // avalon_mm = 2, avalon_mm_uses_ready = 3
 };
 
 // Part of acl_device_def_t where members are populated from the information

include/acl_types.h

@@ -331,6 +331,12 @@ typedef struct host_pipe_struct {
   // non-CSR program hostpipe
   std::string csr_address;
 
+  // Matches the protocol_name enum in
+  // https://github.com/intel/llvm/blob/sycl/sycl/include/sycl/ext/intel/experimental/pipe_properties.hpp
+  // Set a default value in case it's missing.
+  int protocol = -1; // avalon_streaming = 0, avalon_streaming_uses_ready = 1
+                     // avalon_mm = 2, avalon_mm_uses_ready = 3
+
 } host_pipe_t;
 
 // The device-specific information about a program.

src/acl_auto_configure.cpp

@@ -660,6 +660,12 @@ static bool read_hostpipe_mappings(
         read_uint_counters(config_str, curr_pos, mapping.pipe_width,
                            counters) &&
         read_uint_counters(config_str, curr_pos, mapping.pipe_depth, counters);
+    
+    // Start from 2024.0, there is a new field called protocol in the auto-discovery string
+    if (result && counters.back() > 0) {
+      result = result && read_int_counters(config_str, curr_pos,
+                                           mapping.protocol, counters);
+    }
 
     hostpipe_mappings.emplace_back(mapping);
 

src/acl_hostch.cpp

@@ -734,23 +734,25 @@ void acl_read_program_hostpipe(void *user_data, acl_device_op_t *op) {
     unsigned valid_value;
     unsigned *valid_value_pointer = &valid_value;
 
-    // start the CSR read
-
-    // If Blocking, wait until the data is valid.
-    // If Non-blocking, just read once and report failure if not valid.
-    do {
-      acl_get_hal()->read_csr(host_pipe_info.m_physical_device_id, valid_reg,
-                              (void *)valid_value_pointer,
-                              (size_t)sizeof(uintptr_t));
-    } while (blocking && valid_value != 1);
+    // protocol 3 is the avalon_mm_uses_ready protocol
+    // Only this uses_ready protocol requirs reading/writing to ready&valid signals
+    if (host_pipe_info.protocol == 3){
+      // If Blocking, wait until the data is valid.
+      // If Non-blocking, just read once and report failure if not valid.
+      do {
+        acl_get_hal()->read_csr(host_pipe_info.m_physical_device_id, valid_reg,
+                                (void *)valid_value_pointer,
+                                (size_t)sizeof(uintptr_t));
+      } while (blocking && valid_value != 1);
 
-    // If non-blocking and valid bit is not set, set the op to fail.
-    if (!blocking && valid_value == 0) {
-      acl_mutex_unlock(&(host_pipe_info.m_lock));
-      acl_set_device_op_execution_status(op, -1);
-      return;
+      // If non-blocking and valid bit is not set, set the op to fail.
+      if (!blocking && valid_value == 0) {
+        acl_mutex_unlock(&(host_pipe_info.m_lock));
+        acl_set_device_op_execution_status(op, -1);
+        return;
+      }
     }
-
+    // start the CSR read
     auto status =
         acl_get_hal()->read_csr(host_pipe_info.m_physical_device_id, data_reg,
                                 event->cmd.info.host_pipe_info.ptr,
@@ -761,8 +763,11 @@ void acl_read_program_hostpipe(void *user_data, acl_device_op_t *op) {
       return;
     }
     // Tell CSR it's ready
-    acl_get_hal()->write_csr(host_pipe_info.m_physical_device_id, ready_reg,
-                             (void *)&ready, (size_t)sizeof(uintptr_t));
+    // Same reason as above, only avalon_mm_uses_ready needs to do this.
+    if (host_pipe_info.protocol == 3){
+      acl_get_hal()->write_csr(host_pipe_info.m_physical_device_id, ready_reg,
+                              (void *)&ready, (size_t)sizeof(uintptr_t));
+    }
   } else {
     // Non CSR Case
     pulled_data = acl_get_hal()->hostchannel_pull(
@@ -845,7 +850,8 @@ void acl_write_program_hostpipe(void *user_data, acl_device_op_t *op) {
     }
 
     // In non-blocking case, there is no need to write into valid register.
-    if (blocking) {
+    // We only cars about valid register if the protocol is avalon_mm_uses_ready.
+    if (blocking && host_pipe_info.protocol == 3) {
       // Tell CSR it's valid
       acl_get_hal()->write_csr(host_pipe_info.m_physical_device_id, valid_reg,
                                (void *)&valid, (size_t)sizeof(uintptr_t));

src/acl_program.cpp

@@ -1363,6 +1363,7 @@ l_register_hostpipes_to_program(acl_device_program_info_t *dev_prog,
         return CL_INVALID_VALUE;
       }
     }
+    host_pipe_info.protocol = hostpipe.protocol;
     acl_mutex_init(&(host_pipe_info.m_lock), NULL);
     // The following property is not used by the program scoped hostpipe but we
     // don't want to leave it uninitialized

test/acl_auto_configure_test.cpp

@@ -1490,14 +1490,14 @@ TEST(auto_configure, cra_ring_root_exist) {
 
 TEST(auto_configure, hostpipe_mappings) {
   const std::string config_str{
-      "23 66 " RANDOM_HASH
+      "23 71 " RANDOM_HASH
       " pac_a10 0 1 13 DDR 2 2 24 1 2 0 4294967296 4294967296 8589934592 0 - 0 "
-      "0 0 0 0 0 1 5 8 pipe_logical_name1 pipe_physical_name1 1 12345 0 1 4 10 "
-      "pipe_logical_name2 pipe_physical_name2 0 12323 1 0 8 20 "
+      "0 0 0 0 0 1 5 9 pipe_logical_name1 pipe_physical_name1 1 12345 0 1 4 10 0 "
+      "pipe_logical_name2 pipe_physical_name2 0 12323 1 0 8 20 1 "
       "pipe_logical_name3 "
-      "pipe_physical_name1 1 12313 0 1 4 10 pipe_logical_name5 "
+      "pipe_physical_name1 1 12313 0 1 4 10 2 pipe_logical_name5 "
       "pipe_physical_name1 0 "
-      "12316 1 0 8 20 pipe_logical_name4 pipe_physical_name3 0 12342 0 1 4 10 "
+      "12316 1 0 8 20 3 pipe_logical_name4 pipe_physical_name3 0 12342 0 1 4 10 3 "
       "3 90 "
       "_ZTS3CRCILi0EE 512 256 1 0 0 1 0 1 0 9 6 0 0 8 1 0 0 6 2 1 8 1024 0 3 6 "
       "0 0 8 1 0 0 6 0 0 8 1 0 0 6 0 0 8 1 0 0 6 2 1 8 1024 0 2 6 0 0 8 1 0 0 "
@@ -1531,6 +1531,7 @@ TEST(auto_configure, hostpipe_mappings) {
   CHECK(devdef.hostpipe_mappings[0].is_write);
   CHECK(devdef.hostpipe_mappings[0].pipe_width == 4);
   CHECK(devdef.hostpipe_mappings[0].pipe_depth == 10);
+  CHECK(devdef.hostpipe_mappings[0].protocol == 0);
 
   CHECK(devdef.hostpipe_mappings[1].logical_name == "pipe_logical_name2");
   CHECK(devdef.hostpipe_mappings[1].physical_name == "pipe_physical_name2");