Menu

Intel – Altera MCDMA IP Sample

Direct Memory Access (DMA) is a cornerstone of modern FPGA and embedded system designs

Intel’s Multi-Channel DMA (MCDMA) IP extends this capability by supporting concurrent, independent DMA channels in a single core, allowing higher throughput and flexible data management. To integrate and test such IP efficiently in custom boards, developers often face the challenge of writing kernel-mode drivers, handling interrupts, and ensuring portability across operating systems.


What is Intel’s MCDMA IP?

Intel provides a suite of DMA IP cores as part of its FPGA offerings. The MCDMA IP is designed as follows:

  • Each DMA channel consists of a Host-to-Device (H2D) and a Device-to-Host (D2H) queue pair.
  • Multiple DMA channels within one instance

  • Independent control over each channel

  • Parallel transfers for higher bandwidth utilization

  • Scatter-gather support for non-contiguous memory transfers

  • Provides Avalon®-MM (AVMM) and Avalon®-ST (AVST) interfaces (Note: The sample currently supports only AVMM but it can be adjusted)

  • Descriptor Completion: It offers per-descriptor completion notification using either MSI-X interrupts, Writebacks or polling.

  • Control Registers: It provides 4 MB of control register space (mapped to PCIe BAR0) for queue control and status (QCSR), MSI-X interrupt generation, and general global control (GCSR)

In short, MCDMA brings scalability and efficiency, particularly in high-performance FPGA systems with diverse data pipelines.


Why Use WinDriver with MCDMA?

Traditionally, developers working with DMA IP would need to:

  • Write kernel-mode drivers for Linux or Windows,
  • Implement low-level interrupt service routines,
  • Manage scatter-gather descriptors,
  • Debug synchronization and memory issues.

This effort can take weeks or months and is prone to errors. Jungo WinDriver provides a cross-platform driver development kit that abstracts these complexities. With WinDriver, engineers can:

  • Access FPGA DMA registers directly from user space,
  • Rely on automatically generated kernel drivers,
  • Use ready-made DMA samples for Intel IP cores (including MCDMA),
  • Debug transfers quickly with diagnostic applications,
  • Deploy drivers on Windows, Linux, or Linux ARM with minimal changes.

For the MCDMA specifically, Jungo supplies a reference sample that demonstrates:

  • Initialization of DMA channels,
  • Submitting scatter-gather descriptors,
  • Handling channel completion interrupts,
  • Monitoring transfer status,
  • Gracefully stopping and restarting DMA operations.

Practical Applications

Using MCDMA with WinDriver is particularly beneficial in domains such as:

  • Video Processing: Streaming multiple HD video channels simultaneously.
  • Networking: Handling packet flows across parallel DMA channels.
  • Data Acquisition: Collecting sensor data in real time and writing to memory without CPU bottlenecks.
  • AI/ML Acceleration: Feeding large data sets to hardware accelerators with minimal host overhead.

Setting Up the MCDMA IP Sample

  1. Integrate the MCDMA IP in Intel Quartus Platform Designer
    • Configure the IP.
    • Connect the DMA and/or bypass interfaces to any peripheral to which you want to grant the host access.
  2. Generate HDL and program the FPGA
    • Compile your design with Quartus.
    • Deploy the bitstream to the FPGA board.
  3. Use Jungo DriverWizard
    • Detect the PCIe device hosting the MCDMA.
    • Generate a skeleton driver project automatically.
  4. Run the MCDMA Sample Code
    • Jungo’s sample provides C/C++ source that demonstrates channel setup.
    • Test memory-to-memory transfers.
    • Observe interrupts and completion notifications via the WinDriver API.
  5. Debug with Diag Application
    • WinDriver’s mcdma_diag lets you quickly access registers and confirm that DMA channels are active.

DMA Workflow

Allocate and Lock DMA Buffers

DMA data buffer: Allocate a buffer in user space with malloc(), then lock it for DMA using WDC_DMASGBufLock(). This buffer stores the actual data being transferred.
 

 
DMA descriptor buffer: Allocate and lock a contiguous buffer using WDC_DMAContigBufLock(). This buffer is configured by the software and holds transfer metadata (e.g., source and destination addresses, block size, completion control, etc.).
 

 
Write-back buffer: (if using write-back completion): Allocate and lock an additional contiguous buffer with WDC_DMAContigBufLock(). This buffer is used by the hardware to store the write-back data.
 

 

Configure DMA Descriptors

Configure the transfer descriptors: Populate each descriptor with the required metadata (e.g., source and destination addresses, block length, control fields).
 

 
Initialize the queue: Write the base address and total size of the descriptor buffer into the appropriate QCSR registers.
 

 
The descriptor is structured as follows:
 

 

Initiating the DMA Transfer

The transfer is initiated by updating Q_TAIL_POINTER with the index of the last valid descriptor.
 

 

Completion and Interrupt Handling

When the last descriptor completes, one of the following occurs:

  1. Device register polling: The hardware updates Q_COMPLETED_POINTER with the index of the last completed descriptor.
  2. Host memory polling (write-back): The hardware writes the index of the last completed descriptor to host memory at the address specified by Q_CONSUMED_HEAD_ADDR_L / Q_CONSUMED_HEAD_ADDR_H.
  3. MSI-X interrupts: The hardware raises an interrupt and writes the index of the last completed descriptor to host memory at the address specified by Q_CONSUMED_HEAD_ADDR_L / Q_CONSUMED_HEAD_ADDR_H.

 

Cleanup (DMA Close Routine)

Upon transfer completion, the driver must unlock the DMA buffers, release the associated memory, and reset the device registers state.
 

Key API Interactions

The WinDriver API for DMA abstracts low-level register programming. For example:

  • WDC_DMASGBufLock() – Used to build the DMA data scatter-gather buffer.
  • WDC_DMAContigBufLock() – Used to build the descriptors list.
  • Event-handling callbacks tie into channel completion interrupts.

Time Savings

Instead of manually coding interrupt handlers and DMA setup, developers start from a working example.

Cross-Platform

The same driver code runs on Windows, Linux, or ARM-based Linux with minimal adjustments.

Stability

The WinDriver kernel module handles synchronization and memory mapping safely.

Scalability

Developers can extend from a single channel to multiple MCDMA channels by following the sample’s architecture.

Intel® Stratix® 10 GX

A flagship platform for high-performance designs, including data center acceleration, AI/ML workloads, and real-time signal processing. Fully supports Avalon-MM DMA IP via Qsys.
FPGA Device:
2.8 million logic elements (LEs), 229 Mb of M20K memory
PCIe Interface:
Supports DMA to/from host system memory at high throughput
Memory:
2 × 8 GB DDR4 DIMMs, 72-bit (ECC) with ~25.6 GB/s bandwidth
Transceivers & Expansion:
Up to 96 transceivers @ 17.4 Gbps

Intel® Agilex® 7 FPGAs

High-performance processor interfaces and bandwidth-intensive applications.
Logic Elements (LEs):
Up to 4 million
Transceivers:
Up to 116 Gbps
PCIe Interface:
PCIe 5.0 x16
Memory:
Supports DDR4

Intel® Agilex® 5

Ideal for high-performance applications such as data center acceleration, AI/ML workloads, networking, and real-time signal processing.
Logic Elements (LEs):
Up to 2.8 million LEs
Transceivers:
Up to 112 Gbps (supporting both PAM4 and NRZ signaling)
PCIe Interface:
PCIe 5.0 x16
Memory:
Supports DDR4 and DDR5 with a memory controller for high bandwidth (up to 16 GB of HBM2 supported in certain configurations)
Full Benefits
Guidance
Features
Technical Data

WinDriver Download Free 30 Day Trial

Software License Agreement of WinDriver (TM) Version v16.4.0
© Jungo Connectivity Ltd. 2024 All Rights Reserved

IMPORTANT – READ CAREFULLY: THIS SOFTWARE LICENSE AGREEMENT (“AGREEMENT”) IS A LEGAL AGREEMENT BETWEEN YOU AND JUNGO CONNECTIVITY LTD. (“JUNGO”), FOR THE WINDRIVER SOFTWARE PRODUCT ACCOMPANYING THIS LICENSE (THE “SOFTWARE”). BY INSTALLING, COPYING OR OTHERWISE USING THE SOFTWARE, YOU AGREE TO BE LEGALLY BOUND BY THE TERMS AND CONDITIONS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO THE TERMS AND CONDITIONS OF THIS AGREEMENT, DO NOT INSTALL, COPY, OR OTHERWISE USE THE SOFTWARE.

 

  1. OWNERSHIP OF THE SOFTWARE. All right, title, and interest in and to the Software, including associated intellectual property rights, of any sort and/or kind, are and shall remain solely with Jungo and its licensors, and may be protected by copyright, trademark, patent and trade secret law and international treaties. This Agreement does not convey to you an interest in or to the Software, but only a limited, non-transferable, non-sublicensable, non-exclusive, and revocable right of use, in accordance with the terms of this Agreement. You may not remove any proprietary notices and/or any legends from the Software, in whole or in part.

 

  1. GRANT OF LICENSE. Jungo hereby grants you a personal, non-exclusive, nontransferable, non-sublicensable node-locked and time limited license to use the Software.

 

    – Individuals: Jungo grants you, as an individual, a personal, non-exclusive, “single-user” license to use the Software on a single computer, in the manner provided below, at the site for which the license was given.

 

    – Entities: If you are an entity, Jungo grants you the right to designate one individual within your organization (and only one) to have the right to use the Software on a single computer, in the manner provided below, at the site for which the license was given.

 

    – License Scope: A single user license allows usage of WinDriver and redistribution of certain components (as defined below) within a single end product SKU, for a single device (identified by its VID/PID (USB) or VID/DID (PCI)), and without SDK/API capabilities.  If you need extended license or distribution rights, please contact Jungo.

 

  1. EVALUATION LICENSE. If you have not yet paid license fees for the use of the Software, then Jungo hereby grants you a personal, non-exclusive, non-transferable and non-sublicensable license to internally use the Software for evaluation purposes only, for a period of 30 days (the “Evaluation License”). If, after the expiration of the Evaluation License, you wish to continue using the Software and accompanying written materials, you may do so by remitting the required payment to Jungo, and you will then receive a registration code and a license string that will permit you to use the Software on a single computer under one of the license schemes specified in Section 2 above.

 

  1. SERVICE OPTIMIZATION AND ENHANCEMENT. To continuously improve and optimize Jungo’s services, Jungo reserves the right to anonymously monitor, collect, and analyze usage data, including but not limited to API interactions, performance metrics, and system activity. Such data collection and analysis shall be conducted in compliance with all applicable laws and regulations and shall be used solely for the purpose of enhancing service performance, security, and reliability.
  2. SUBSCRIPTION, SERVICE CONTINUITY, RENEWAL, AND LATE PAYMENT PENALTIES. Access to the WinDriver and its associated features is provided on a subscription basis, subject to annual renewal. Failure to renew the subscription before the expiration date may result in the automatic termination of access to the platform and all related services, and additional fees (including but not limited to late payment penalties, administrative charges, or reinstatement costs). Upon termination, the user shall forfeit any rights to continued use, and we reserve the right to suspend or delete any associated accounts, data, or functionalities without further notice.

 

  1. OPEN SOURCE. The Software includes certain files that are subject to open source licenses. These files are identified in their header files (“Open Source Files”). You must use the Open Source Files in accordance with the terms of their respective licenses.  In the event of any contradiction between the terms of this Agreement, and the terms of the open source license accompanying a certain Open Source File, the terms of the latter shall prevail, with regard to the said Open Source File.

 

RESTRICTIONS ON USE AND TRANSFER

 

  1. DISTRIBUTION OF FILES.

 

    (a) You may not distribute, or otherwise transfer or assign, any portion of the Software, including any of the headers or source files that are included in the Software, unless otherwise expressly permitted in this Agreement, subject to the provisions of Section 4 above.

 

    (b) Subject to your full and continued compliance with the terms of this Agreement, including the ongoing payment of annual license fees, you may distribute the following files:

 

Windows:
-windrvr1640.sys
-windrvr1640_legacy.sys
-windrvr1640.inf
-windrvr1640.cat
-wdapi1640.dll
-wdapi1640_32.dll
-wdapi1640_arm64.dll
-wdapi_dotnet1640.dll
-wdapi_dotnet1640_32.dll
-wdapi_netcore1640.dll
-wdapi_java1640.dll
-wdapi_java1640.jar
-wdreg.exe
-difxapi.dll
-devcon.exe
-windrvr1630.sys
-windrvr1630.inf
-wd1630.cat
-wdapi1630.dll
-wdapi_dotnet1630.dll
-wdapi_java1630.dll wdapi_java1600.jar
-windrvr1220.dll
-wdapi1220.dll

Linux:
-windrvr_gcc_v3.o_shipped
-windrvr_gcc_v3_regparm.o_shipped
-kp_linux_gcc_v3.o
-kp_linux_gcc_v3_regparm.o
-libwdapi1640.so libwdapi1640_32.so
-libwdapi_java1640.so
-libwdapi_java1640_32.so
-wdapi_java1640.jar
-wdapi_netcore1640.dll
-kp_wdapi1640_gcc_v3.o_shipped
-kp_wdapi1640_gcc_v3_regparm.o_shipped
-linux_wrappers.c
-linux_wrappers.h
-wdusb_linux.c
-wdusb_interface.h
-wd_ver.h
-linux_common.h
-windrvr.h
-windrvr_usb.h
-wdsriov_interface.h
-wdsriov_linux.c
-wdreg
-configure makefile.in
-configure.wd makefile.wd.in
-makefile.wd.kbuild.in
-configure.usb
-makefile.usb.in
-makefile.usb.kbuild.in
-setup_inst_dir
-windrvr_gcc_v2.a windrvr_gcc_v3.a windrvr_gcc_v3_regparm.a
-kp_linux_gcc_v2.o kp_linux_gcc_v3.o kp_linux_gcc_v3_regparm.o
-libwdapi1630.so
-libwdapi_java1630.so wdapi_java1600.java
-kp_wdapi1630_gcc_v2.a kp_wdapi1600_gcc_v3.a kp_wdapi1600_gcc_v3_regparm.a
-linux_wrappers.c linux_wrappers.h wdusb_linux.c
-wdusb_interface.h wd_ver.h linux_common.h windrvr.h windrvr_usb.h
-configure.wd makefile.wd.in makefile.wd.kbuild.in
-configure.usb makefile.usb.in makefile.usb.kbuild.in

macOS:
-libwdapi1640.dyld
-libwdapi_java1640.jar
-libwdapi_java1640.dyld
-wdapi_netcore1640.dll
-WinDriver1640.kext
-WinDriver1640.dext
-wd_mac_install.sh
-wd_mac_uninstall.sh

 

    (c) The files listed in Section 5.b above may be distributed only as part of a complete application that you distribute under your organization name, and only if they significantly contribute to the functionality of your application. For avoidance of doubt, each organization distributing these files as part of the organization products is required to have valid license(s) under the organization name/VID, irrespective of the party who actually performed the product development. Licenses granted to subcontractors do not grant distribution or other rights to the organizations for which they are developing.

 

    (d) The distribution of the windrvr.h header file is permitted only on Linux.

 

    (e) You may not modify the distributed files specified in Section 5.b of this Agreement.

 

    (f) You may not distribute any header file that describes the WinDriver functions, or functions that call the WinDriver functions and have the same basic functionality as that of the WinDriver functions.

 

  1. The Software may not be used to develop a development product, an API, or any products, which will eventually be part of a development product or environment, without the written consent of Jungo and subject to additional fees and licensing terms.

 

  1. You may make printed copies of the written materials accompanying the Software, provided that only users bound by this license use them.

 

  1. You may not allow any third party to use the Software, grant access to the Software (or any portion thereof) to any third party, or otherwise make any commercial use of the Software, including without limitation, assign, distribute, sublicense, transfer, pledge, lease, rent, or share your rights in the Software or any of your rights under this Agreement, all whether or not for any consideration.

 

  1. You may not translate, reverse engineer, decompile, disassemble, reproduce, duplicate, copy, or otherwise disseminate all or any part of the Software, or extract source code from the object code of the Software.

 

  1. Jungo reserves the right to revise, update, change, modify, add to, supplement, or delete any and all terms of this License Agreement; provided, however, that changes to this License Agreement will not be applied retroactively. Such changes will be effective with or without prior notice to you. You can review the most current version of this License Agreement under the WinDriver download form page.

 

  1. You may not incorporate or link any open source software with any open source software part of the Software, or otherwise take any action which may cause the Software or any portion thereof to be subjected to the terms of the Free Software Foundation’s General Public License (GPL) or Lesser General Public License (LGPL), or of any other open source code license.

 

  1. DISCLAIMER OF WARRANTY. THIS SOFTWARE AND ITS ACCOMPANYING WRITTEN MATERIALS ARE PROVIDED BY JUNGO “AS IS” WITHOUT ANY WARRANTY. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT, ARE HEREBY DISCLAIMED TO THE FULLEST EXTENT PERMITTED UNDER APPLICABLE LAW.

 

  1. NO LIABILITY. TO THE FULLEST EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT SHALL JUNGO OR ITS LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, SAVINGS, IP INFRINGEMENT OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 

  1. Governing Law. This Agreement and use of the Software are governed by the laws of the State of Israel, regardless of its conflict of laws rules, and the competent courts of the State of Israel shall have sole and exclusive jurisdiction over any dispute under this Agreement or otherwise related to the Software.

 

  1. Confidentiality. The Software, including any additional information related thereto, contains confidential and proprietary information of Jungo.  Accordingly, you agree that you will not, nor allow any third party to, disseminate, transfer, grant access to, or otherwise disclose to any third party the Software or any part thereof or any other confidential or proprietary information of Jungo provided in connection therewith. You will maintain all copies of the Software and all related documentation in confidence.

 

  1. Termination and Effects of Termination. Jungo may terminate this Agreement and the licenses granted to you hereunder at any time if you breach any of your obligations hereunder, by issuance of written notice to such effect, addressed to you at the address you provided in your registration form. Upon expiration or other termination of this Agreement, the Licenses granted to you hereunder shall immediately and automatically be canceled, and you will immediately remove all copies of the Software from your computer(s) and cease any use thereof.

 

  1. Contact Details. If you have any questions concerning this Agreement or wish to contact Jungo for any reason —

 

          Web site: https://www.jungo.com

          Email:    [email protected]

 

  1. US GOVERNMENT RESTRICTED RIGHTS. The Software and documentation are provided with RESTRICTED RIGHTS.

  Use, duplication, or disclosure by the Government is subject to restrictions set forth in subparagraph (c)(1) of The Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 or subparagraphs (c)(1)(ii) and (2) of Commercial Computer Software – Restricted Rights at 48 CFR 52.227-19, as applicable.

 

  1. Automatic Renewal. The subscription shall be automatically renewed, unless Licensee notifies Licensor 30 days or more prior to the expiration date of the subscription, of its intent not to renew the subscription.

Accessibility Toolbar