Modify host channel port IDs into an enum

Author: sophimao

include/MMD/aocl_mmd.h

@@ -128,9 +128,11 @@ typedef enum {
    AOCL_MMD_USES_YIELD = 5,    /* 1 if yield must be called to poll hw (int) */
    /**
     *  The following can be combined in a bit field:
-    *  AOCL_MMD_PHYSICAL_MEMORY, AOCL_MMD_SVM_COARSE_GRAIN_BUFFER, AOCL_MMD_SVM_FINE_GRAIN_BUFFER, AOCL_MMD_SVM_FINE_GRAIN_SYSTEM.
-    *  Prior to 14.1, all existing devices supported physical memory and no types of SVM memory, so this
-    *  is the default when this operation returns '0' for board MMDs with a version prior to 14.1
+    *  AOCL_MMD_PHYSICAL_MEMORY, AOCL_MMD_SVM_COARSE_GRAIN_BUFFER,
+    *  AOCL_MMD_SVM_FINE_GRAIN_BUFFER, AOCL_MMD_SVM_FINE_GRAIN_SYSTEM.
+    *  Prior to 14.1, all existing devices supported physical memory and no types
+    *  of SVM memory, so this is the default when this operation returns '0' for
+    *  board MMDs with a version prior to 14.1.
     */
    AOCL_MMD_MEM_TYPES_SUPPORTED = 6,
 } aocl_mmd_offline_info_t;
@@ -140,7 +142,8 @@ typedef enum {
  *  Possible capabilities to return from AOCL_MMD_*_MEM_CAPABILITIES query
  */
 /**
- *  If not set allocation function is not supported, even if other capabilities are set.
+ *  If not set allocation function is not supported, even if other capabilities
+ *  are set.
  */
 #define AOCL_MMD_MEM_CAPABILITY_SUPPORTED      (1 << 0)
 /**
@@ -172,7 +175,7 @@ typedef enum {
  *  AOCL_MMD_PLL_INTERFACES - the handle for each pll associated with each
  *  kernel interface. If a kernel interface is not clocked by acl_kernel_clk
  *  then return -1
- **/
+ */
 typedef enum {
    AOCL_MMD_NUM_KERNEL_INTERFACES = 1,  /* Number of Kernel interfaces (int) */
    AOCL_MMD_KERNEL_INTERFACES = 2,      /* Kernel interface (int*) */
@@ -198,7 +201,7 @@ typedef struct {
    unsigned long long int exception_type;
    void *user_private_info;
    size_t user_cb;
-}aocl_mmd_interrupt_info;
+} aocl_mmd_interrupt_info;
 
 typedef void (*aocl_mmd_interrupt_handler_fn)( int handle, void* user_data );
 typedef void (*aocl_mmd_device_interrupt_handler_fn)( int handle, aocl_mmd_interrupt_info* data_in, void* user_data );
@@ -207,29 +210,30 @@ typedef void (*aocl_mmd_status_handler_fn)( int handle, void* user_data, aocl_mm
 /**
  *  Host channel port IDs
  */
-typedef int aocl_mmd_hostchannel_port_id_t;
-/**
- *  Port ID for Avalon streaming interface startofpacket signal.
- */
-#define AOCL_MMD_HOSTCHANNEL_PORT_AVALON_SOP   1
-/**
- *  Port ID for Avalon streaming interface endofpacket signal.
- *  This port ID is currently shared with AXI streaming interface tlast signal.
- */
-#define AOCL_MMD_HOSTCHANNEL_PORT_AVALON_EOP   2
-/**
- *  Port ID for Avalon streaming interface empty signal.
- */
-#define AOCL_MMD_HOSTCHANNEL_PORT_AVALON_EMPTY 3
-/**
- *  Port ID for AXI streaming interface tlast signal.
- *  This port ID is currently shared with Avalon streaming interface endofpacket signal.
- */
-#define AOCL_MMD_HOSTCHANNEL_PORT_AXI_TLAST    2
-/**
- *  Port ID for AXI streaming interface tuser signal.
- */
-#define AOCL_MMD_HOSTCHANNEL_PORT_AXI_TUSER    4
+typedef enum {
+   /**
+    *  Unknown port ID.
+    */
+   AOCL_MMD_HOSTCHANNEL_PORT_UNKNOWN = -1,
+   /**
+    *  Port ID for general data signal. This port ID is not to be used with
+    *  aocl_mmd_hostchannel_get_sideband_buffer(), to get the MMD buffer for
+    *  data port, user aocl_mmd_hostchannel_get_buffer() directly.
+    */
+   AOCL_MMD_HOSTCHANNEL_PORT_DATA = 0,
+   /**
+    *  Port ID for Avalon streaming interface startofpacket signal.
+    */
+   AOCL_MMD_HOSTCHANNEL_PORT_AVALON_SOP = 1,
+   /**
+    *  Port ID for Avalon streaming interface endofpacket signal.
+    */
+   AOCL_MMD_HOSTCHANNEL_PORT_AVALON_EOP = 2,
+   /**
+    *  Port ID for Avalon streaming interface empty signal.
+    */
+   AOCL_MMD_HOSTCHANNEL_PORT_AVALON_EMPTY = 3,
+} aocl_mmd_hostchannel_port_id_t;
 
 
 /**
@@ -254,10 +258,10 @@ typedef enum {
    */
   AOCL_MMD_MEM_PROPERTIES_GLOBAL_MEMORY=1,
   /**
-   *  Specifies the index of a bank inside the global memory interface that can be found in
-   *  the board_spec.xml file for the BSP. Allocations will be allocated to this
-   *  memory bank. It is invalid to specify this property without also specifying
-   *  AOCL_MMD_GLOBAL_MEMORY_INTERFACE.
+   *  Specifies the index of a bank inside the global memory interface that can be
+   *  found in the board_spec.xml file for the BSP. Allocations will be allocated
+   *  to this memory bank. It is invalid to specify this property without also
+   *  specifying AOCL_MMD_GLOBAL_MEMORY_INTERFACE.
    */
   AOCL_MMD_MEM_PROPERTIES_MEMORY_BANK,
   /**
@@ -463,11 +467,13 @@ AOCL_MMD_CALL int aocl_mmd_copy(
  *  Host Channel create operation
  *  Opens channel between host and kernel.
  *
- *  @param  channel_name: Name of channel to initialize. Same name as used in board_spec.xml
+ *  @param  channel_name: Name of channel to initialize. Same name as used in
+            board_spec.xml
  *  @param  queue_depth: The size in bytes of pinned memory queue in system memory
  *  @param  direction: The direction of the channel
- *  @return negative if initialization was unsuccessful, and positive otherwise. Positive
- *           return value is handle to the channel to be used for subsequent calls for the channel.
+ *  @return negative if initialization was unsuccessful, and positive otherwise.
+            Positive return value is handle to the channel to be used for
+            subsequent calls for the channel.
  */
 AOCL_MMD_CALL int aocl_mmd_hostchannel_create(
       int handle,
@@ -481,8 +487,8 @@ AOCL_MMD_CALL int aocl_mmd_hostchannel_create(
  *  Host Channel destroy operation
  *  Closes channel between host and kernel.
  *
- *  @param channel: The handle to the channel to close, that was obtained with
- *             create channel
+ *  @param  channel: The handle to the channel to close, that was obtained with
+ *          create channel
  *  @return 0 if the destroy was successful, and negative otherwise.
  */
 AOCL_MMD_CALL int aocl_mmd_hostchannel_destroy(

include/acl.h

@@ -559,17 +559,6 @@ struct acl_sideband_signal_mapping {
   unsigned sideband_size; // bit
 };
 
-// Must match the definition in the compiler
-// Analysis/FPGAAnalysis/Utils/StreamParameters.h
-enum signal_type {
-  SignalUnknown = -1,
-  AvalonData = 0,
-  AvalonSOP = 1,
-  AvalonEOP = 2, // Same as AXILast
-  AvalonEmpty = 3,
-  AXIUser = 4
-};
-
 // Part of acl_device_def_t where members are populated from the information
 // in the autodiscovery string. This will get updated every time the device
 // is programmed with a new device binary as the new binary would contain a

include/acl_types.h

@@ -296,7 +296,8 @@ typedef struct host_op_struct {
 } host_op_t;
 
 struct sideband_signal_t {
-  unsigned port_identifier; // matches enum signal_type in acl.h
+  unsigned port_identifier; // matches enum aocl_mmd_hostchannel_port_id_t in
+                            // aocl_mmd.h
   unsigned port_offset;     // in bit
   unsigned side_band_size;  // in bit
 };

src/acl_hal_mmd.cpp

@@ -2559,10 +2559,11 @@ size_t acl_hal_mmd_hostchannel_sideband_pull_no_ack(
 
   assert(device_info[physical_device_id]
              .mmd_dispatch->aocl_mmd_hostchannel_get_sideband_buffer);
-  pull_buffer =
-      device_info[physical_device_id]
-          .mmd_dispatch->aocl_mmd_hostchannel_get_sideband_buffer(
-              pcie_dev_handle, channel_handle, port_name, &buffer_size, status);
+  pull_buffer = device_info[physical_device_id]
+                    .mmd_dispatch->aocl_mmd_hostchannel_get_sideband_buffer(
+                        pcie_dev_handle, channel_handle,
+                        static_cast<aocl_mmd_hostchannel_port_id_t>(port_name),
+                        &buffer_size, status);
 
   if ((NULL == pull_buffer) || (0 == buffer_size)) {
     return 0;
@@ -2595,10 +2596,11 @@ size_t acl_hal_mmd_hostchannel_sideband_push_no_ack(
   assert(device_info[physical_device_id]
              .mmd_dispatch->aocl_mmd_hostchannel_get_sideband_buffer);
 
-  push_buffer =
-      device_info[physical_device_id]
-          .mmd_dispatch->aocl_mmd_hostchannel_get_sideband_buffer(
-              pcie_dev_handle, channel_handle, port_name, &buffer_size, status);
+  push_buffer = device_info[physical_device_id]
+                    .mmd_dispatch->aocl_mmd_hostchannel_get_sideband_buffer(
+                        pcie_dev_handle, channel_handle,
+                        static_cast<aocl_mmd_hostchannel_port_id_t>(port_name),
+                        &buffer_size, status);
 
   if ((NULL == push_buffer) || (0 == buffer_size)) {
     return 0;

src/acl_hostch.cpp

@@ -71,7 +71,8 @@ static cl_int l_push_sideband_packet(unsigned int physical_device_id,
   for (auto const &sideband_signal_entry :
        host_pipe_info.side_band_signals_vector) {
     size_t pushed_data;
-    if (sideband_signal_entry.port_identifier == AvalonData) {
+    if (sideband_signal_entry.port_identifier ==
+        static_cast<unsigned>(AOCL_MMD_HOSTCHANNEL_PORT_DATA)) {
       pushed_data = acl_get_hal()->hostchannel_push_no_ack(
           host_pipe_info.m_physical_device_id, host_pipe_info.m_channel_handle,
           (const void *)((char *)host_buffer +
@@ -117,7 +118,8 @@ static size_t l_pull_sideband_packet(unsigned int physical_device_id,
   for (auto const &sideband_signal_entry :
        host_pipe_info.side_band_signals_vector) {
     size_t pulled_data;
-    if (sideband_signal_entry.port_identifier == AvalonData) {
+    if (sideband_signal_entry.port_identifier ==
+        static_cast<unsigned>(AOCL_MMD_HOSTCHANNEL_PORT_DATA)) {
       pulled_data = acl_get_hal()->hostchannel_pull_no_ack(
           host_pipe_info.m_physical_device_id, host_pipe_info.m_channel_handle,
           (void *)((char *)host_buffer + sideband_signal_entry.port_offset / 8),

src/acl_program.cpp

@@ -1396,7 +1396,8 @@ l_register_hostpipes_to_program(acl_device_program_info_t *dev_prog,
 
     auto &host_pipe_info =
         dev_prog->program_hostpipe_map.at(sideband_signal_mapping.logical_name);
-    if (sideband_signal_mapping.port_identifier != AvalonData) {
+    if (sideband_signal_mapping.port_identifier !=
+        static_cast<unsigned>(AOCL_MMD_HOSTCHANNEL_PORT_DATA)) {
       host_pipe_info.num_side_band_signals++;
     }