Scalable Scatter-Gather DMA Intel® FPGA IP User Guide

Download PDF
ID 823097
Date 4/07/2025
Public
Document Table of Contents
Document Table of Contents x
1. Terms and Acronyms 2. Introduction 3. Functional Description 4. Interfaces 5. HAL Driver for DMA SoC Mode  6. Parameters 7. Registers 8. Document Revision History for the Scalable Scatter-Gather DMA Intel® FPGA IP User Guide
2. Introduction x
2.1. Device Family Support 2.2. Release Information 2.3. Resource Utilization
3. Functional Description x
3.1. DMA PCIe* Mode 3.2. DMA SoC Mode 3.3. Device Port 3.4. Prefetcher Engine 3.5. DMA Arbiter 3.6. DMA Router 3.7. CSRUnit 3.8. Descriptor Handling 3.9. Interrupts 3.10. Reset Initialization Flows 3.11. Transaction Flow
3.1. DMA PCIe* Mode x
3.1.1. Submodules
3.1.1. Submodules x
3.1.1.1. PCIe* TLP Constructor 3.1.1.2. PCIe* TLP ID Generation 3.1.1.3. PCIe TX Credit Controller 3.1.1.4. PCIe* TX Scheduler 3.1.1.5. PCIe TLP Completer 3.1.1.6. PCIe RX Router 3.1.1.7. PCIe* MSI-X Controller 3.1.1.8. PCIe BAR0 3.1.1.9. PCIe Bursting Manager (BAM) 3.1.1.10. Completion Timeout Parser 3.1.1.11. Control Shadow Parser
3.2. DMA SoC Mode x
3.2.1. Interrupt Controller 3.2.2. Host AXI-4 Agent 3.2.3. Host CSR AXI-4 Lite Agent
3.3. Device Port x
3.3.1. ST Source Agent/ST Sink Agent/MM Agent 3.3.2. Descriptor Engine 3.3.3. Agent Controller 3.3.4. Constructor 3.3.5. Responder 3.3.6. Width Adaptation FIFO
3.8. Descriptor Handling x
3.8.1. Link Descriptor 3.8.2. Data Descriptor 3.8.3. Responder Descriptor 3.8.4. Descriptor Chain 3.8.5. Aligned and Unaligned Transfer Support
3.8.2. Data Descriptor x
3.8.2.1. Data Descriptor - H2D Streaming Transfer 3.8.2.2. Data Descriptor - D2H Streaming Transfer 3.8.2.3. Data Descriptor - H2D Memory Transfer
3.8.3. Responder Descriptor x
3.8.3.1. Responder Descriptor - H2D Streaming Transfer 3.8.3.2. Responder Descriptor - D2H Streaming Transfer 3.8.3.3. Responder Descriptor - H2D Memory Transfer
3.8.4. Descriptor Chain x
3.8.4.1. Descriptor Fetch and Status Update Mechanism
3.11. Transaction Flow x
3.11.1. General DMA Operation Flow 3.11.2. Host to Device (H2D) Flow 3.11.3. Device to Host (D2H) Flow 3.11.4. Soft Reset Handshake Flow
4. Interfaces x
4.1. Port List 4.2. DMA PCIe* Mode Interfaces 4.3. DMA SoC Mode Interfaces 4.4. Device Port Interfaces 4.5. Resets 4.6. Clocks
4.2. DMA PCIe* Mode Interfaces x
4.2.1. Application Packet Receive Interface 4.2.2. Application Packet Transmit Interface 4.2.3. Control Shadow Interface 4.2.4. Transmit Flow Control Credit Interface 4.2.5. Completion Timeout Interface 4.2.6. PCIe* Miscellaneous Signals 4.2.7. Control and Status Register Responder Manager Interface 4.2.8. Bursting Manager Interface
4.3. DMA SoC Mode Interfaces x
4.3.1. Host AXI-4 Memory Map Manager Interface 4.3.2. Host AXI-4 Lite CSR Memory Map Subordinate Interface 4.3.3. Interrupt Interface
4.4. Device Port Interfaces x
4.4.1. Device to Host <PORT#> AXI-ST Subordinate Interface 4.4.2. Device to Host <PORT#> Avalon-ST Sink Interface 4.4.3. Host to Device <PORT#> AXI-ST Manager Interface 4.4.4. Host to Device <PORT#> Avalon-ST Source Interface 4.4.5. Host to Device <PORT#> AXI-4 Manager Interface
5. HAL Driver for DMA SoC Mode  x
5.1. Descriptor Indexing  5.2. HAL Public API 
5.1. Descriptor Indexing  x
5.1.1. Data Descriptors  5.1.2. Responders 
5.2. HAL Public API  x
5.2.1. Software Features 5.2.2. intel_ssgdma.c  5.2.3. intel_ssgdma_global.c 5.2.4. intel_ssgdma_device_port.c  5.2.5. intel_ssgdma_descriptor.c 
6. Parameters x
6.1. DMA Settings 6.2. Device Port Settings 6.3. DMA PCIe Mode Settings 6.4. DMA SoC Mode Settings 6.5. Example Design
6.2. Device Port Settings x
6.2.1. H2D MM 6.2.2. H2D ST 6.2.3. D2H ST
7. Registers x
7.1. Global CSR 7.2. MSI-X Memory Space 7.3. Device Port Control Register
1. Terms and Acronyms
2. Introduction
3. Functional Description
4. Interfaces
5. HAL Driver for DMA SoC Mode 
6. Parameters
7. Registers
8. Document Revision History for the Scalable Scatter-Gather DMA Intel® FPGA IP User Guide

8. Document Revision History for the Scalable Scatter-Gather DMA Intel® FPGA IP User Guide

Date Quartus® Prime Version IP Version Changes
2025.04.07 25.1 1.2.0
  • Updated Release Information for the SSGDMA IP table.
  • Updated Resource Utilization table.
  • Updated topic DMA PCIe* Mode to add a new comparison table with MCDMA.
  • Updated the following topics:
    • Device Port.
    • Descriptor Fetch and Status Update Mechanism
    • General DMA Operation Flow
  • Updated the description in the following tables:
    • Link Descriptor — Field Description
    • Data Descriptor — Field Description
    • Responder Descriptor — Field Description
    • D2H ST Parameters
    • SSGDMA Address Space
    • Device Port Register Map
  • Updated the following figures:
    • Descriptor Chain / Ring buffer for Descriptor Blocks (Continuous Ring)
    • Descriptor Chain for Descriptor Blocks (Stop at Last Descriptor)
    • Descriptor Chain for Responder Block
  • Removed parameter Data Type of D2H ST Port<n> from the following tables:
    • H2D ST Parameters
    • D2H ST Parameters
  • Added new row for Maximum Read Request Size in DMA PCIe Mode Settings table
  • Updated VER_NUM (0x10C) table.
  • Added new row for Q_EXTRACT_POINTER_ACK in Device Port Register Map table.
  • Updated Q_PORT_PARAM1 (0x38) table.
  • Added Q_EXTRACT_POINTER_ACK (0x40) table.
2025.01.27 24.3.1 1.1.3
  • Updated Release Information for the SSGDMA IP table.
  • Updated Resource Utilization table.
  • Updated section Functional Description:
    • Updated the topic DMA PCIe* Mode to add Single physical function as the new DMA PCIe functionalities.
    • Added a note about transfer length in the Data Descriptor - Field Description table
    • Added description for Offset 0x10 for Byte Lane 0 in the Data Descriptor - H2D Streaming Transfer table
  • Updated section Interfaces:
    • Added new ports in the Scalable Scatter-Gather DMA IP Port List figures
    • Updated the following tables:
      • Completion Timeout Interface
      • Device to Host <PORT> AXI-ST Subordinate Interface
      • Device to Host <PORT> PTP AXI-ST Subordinate Interface
      • Device to Host Avalon-ST Sink Interface
      • Host to Device AXI-ST Manager Interface
      • Host to Device <PORT> PTP AXI-ST Subordinate Interface
      • Host to Device <PORT#> Avalon-ST Source Interface
  • Updated the following tables in section Parameters:
    • DMA Settings
    • H2D ST Parameters
    • D2H ST Parameters
    • DMA PCIe Mode Settings
    • DMA SoC Mode Settings
    • Example Design
  • Updated the following tables in section Registers:
    • SSGDMA Address Space
    • CTRL (Offset 0x100)
    • WB_INTR_TIMEOUT ( 0x108)
    • WATCHDOG_TIMEOUT (0x114)
    • SCRATCH (0x118)
    • Device Port Register Map
    • Q_CTRL (Offset 0x0)
    • Q_STATUS (Offset 0x4)
    • Q_START_ADDR_L (0x8)
2024.10.07 24.3 1.1.2
  • Removed the statement about the support for Agilex™ 5 D-Series FPGAs and SoC in the Quartus® Prime Pro Edition.
  • Updated Release Information for the SSGDMA IP table.
  • Updated Resource Utilization table.
  • Updated DMA PCIe* Mode to add more clarity about functionalities of the 300 MHz AXI-ST interface clock frequency.
  • Updated PCIe Bursting Manager (BAM) to add more clarity about including the support for 128-bit data width.
  • Updated Device Port with information on aligned transfer for H2D ST and D2H ST device ports.
  • Updated Format Field Definition for Descriptor table to add H2D and D2H Streaming Transfer with Timestamp responder descriptor format.
  • Updated Data Descriptor — Field Description to remove the description of DWORD aligned transfer from the Length field and added a note about adhering to supported alignment modes.
  • Updated Responder Descriptor — Field Description table to add device port unaligned access and PTP Timestamp support IP parameters.
  • Added new table Responder Descriptor – D2H Streaming Transfer with Timestamp to the topic Responder Descriptor - D2H Streaming Transfer.
  • Added new topics:
    • Aligned and Unaligned Transfer Support
    • Soft Reset Handshake Flow
  • Updated figure Scalable Scatter-Gather DMA IP Port List Part 2 to add new interfaces:
    • Device to Host <PORT> PTP AXI-ST Subordinate Interface
    • Host to Device <PORT> PTP AXI-ST Subordinate Interface
  • Updated the following topics with notes about connecting the interface to AXI4-Stream interfaces:
    • Application Packet Receive Interface
    • Application Packet Transmit Interface
    • Control and Status Register Responder Manager Interface
  • Updated the following topics to add more detail about the interface:
    • Transmit Flow Control Credit Interface
    • Completion Timeout Interface
  • Updated the data description in the following tables
    • Control and Status Register Responder Manager Interface
    • Device to Host Avalon-ST Sink Interface
    • Host to Device AXI-ST Manager Interface
    • Host to Device Avalon-ST Source Interface
  • Added new tables:
    • Device to Host <PORT> PTP AXI-ST Subordinate Interface
    • Host to Device <PORT> PTP AXI-ST Subordinate Interface
  • Updated the following tables to remove deprecated IP parameters and added new parameter.
    • DMA Settings
    • H2D MM Parameters
    • H2D ST Parameters
    • DMA PCIe Mode Settings
    • DMA SoC Mode Settings
  • Updated the values in the following table:
    • STATUS (0x14)
    • VER_NUM (0x10C)
    • IP_PARAM (0x11C)
    • Q_PORT_PARAM1 (0x38)
2024.07.08 24.2 1.1.1 Initial release.
Level Two Title