Intel® FPGA SDK for OpenCL™ Pro Edition: Custom Platform Toolkit User Guide

ID 683085
Date 3/28/2022
Document Table of Contents

2.3.16. aocl_mmd_hostchannel_create

The aocl_mmd_hostchannel_create function creates a channel interface.


int aocl_mmd_hostchannel_create( int handle,
                                 char *channel_name,
                                 size_t queue_depth,
                                 int direction );

Function Arguments

  • handle—A positive int value representing the handle to the board obtained from the aocl_mmd_open() call.
  • channel_name—Name of the channel to be initialized. The channel name is same as that used in the board_spec.xml file.
  • queue_depth—The size of pinned internal buffer in bytes. Pointer to the internal buffer is provided when the user calls the aocl_mmd_hostchannel_get_buffer() function.
  • direction—The direction of the channel.

Return Value

If the function executes successfully, the return value is positive and is handle to the channel.

If the function fails to execute, a negative return value indicates an error.