Scalable Scatter-Gather DMA FPGA IP User Guide

Download PDF
ID 823097
Date 9/22/2025
Public
Document Table of Contents
Document Table of Contents x
1. Product Discontinuance Notification 2. Terms and Acronyms 3. Introduction 4. Functional Description 5. Interfaces 6. HAL Driver for DMA SoC Mode  7. Parameters 8. Registers 9. Document Revision History for the Scalable Scatter-Gather DMA Intel® FPGA IP User Guide
3. Introduction x
3.1. Device Family Support 3.2. Release Information 3.3. Resource Utilization
4. Functional Description x
4.1. DMA PCIe* Mode 4.2. DMA SoC Mode 4.3. Device Port 4.4. Prefetcher Engine 4.5. DMA Arbiter 4.6. DMA Router 4.7. CSRUnit 4.8. Descriptor Handling 4.9. Interrupts 4.10. Reset Initialization Flows 4.11. Transaction Flow
4.1. DMA PCIe* Mode x
4.1.1. Submodules
4.1.1. Submodules x
4.1.1.1. PCIe* TLP Constructor 4.1.1.2. PCIe* TLP ID Generation 4.1.1.3. PCIe TX Credit Controller 4.1.1.4. PCIe* TX Scheduler 4.1.1.5. PCIe TLP Completer 4.1.1.6. PCIe RX Router 4.1.1.7. PCIe* MSI-X Controller 4.1.1.8. PCIe BAR0 4.1.1.9. PCIe Bursting Manager (BAM) 4.1.1.10. Completion Timeout Parser 4.1.1.11. Control Shadow Parser
4.2. DMA SoC Mode x
4.2.1. Interrupt Controller 4.2.2. Host AXI-4 Agent 4.2.3. Host CSR AXI-4 Lite Agent
4.3. Device Port x
4.3.1. ST Source Agent/ST Sink Agent/MM Agent 4.3.2. Descriptor Engine 4.3.3. Agent Controller 4.3.4. Constructor 4.3.5. Responder 4.3.6. Width Adaptation FIFO
4.8. Descriptor Handling x
4.8.1. Link Descriptor 4.8.2. Data Descriptor 4.8.3. Responder Descriptor 4.8.4. Descriptor Chain 4.8.5. Aligned and Unaligned Transfer Support
4.8.2. Data Descriptor x
4.8.2.1. Data Descriptor - H2D Streaming Transfer 4.8.2.2. Data Descriptor - D2H Streaming Transfer 4.8.2.3. Data Descriptor - H2D Memory Transfer
4.8.3. Responder Descriptor x
4.8.3.1. Responder Descriptor - H2D Streaming Transfer 4.8.3.2. Responder Descriptor - D2H Streaming Transfer 4.8.3.3. Responder Descriptor - H2D Memory Transfer
4.8.4. Descriptor Chain x
4.8.4.1. Descriptor Fetch and Status Update Mechanism
4.11. Transaction Flow x
4.11.1. General DMA Operation Flow 4.11.2. Host to Device (H2D) Flow 4.11.3. Device to Host (D2H) Flow 4.11.4. Soft Reset Handshake Flow
5. Interfaces x
5.1. Port List 5.2. DMA PCIe* Mode Interfaces 5.3. DMA SoC Mode Interfaces 5.4. Device Port Interfaces 5.5. Resets 5.6. Clocks
5.2. DMA PCIe* Mode Interfaces x
5.2.1. Application Packet Receive Interface 5.2.2. Application Packet Transmit Interface 5.2.3. Control Shadow Interface 5.2.4. Transmit Flow Control Credit Interface 5.2.5. Completion Timeout Interface 5.2.6. PCIe* Miscellaneous Signals 5.2.7. Control and Status Register Responder Manager Interface 5.2.8. Bursting Manager Interface
5.3. DMA SoC Mode Interfaces x
5.3.1. Host AXI-4 Memory Map Manager Interface 5.3.2. Host AXI-4 Lite CSR Memory Map Subordinate Interface 5.3.3. Interrupt Interface
5.4. Device Port Interfaces x
5.4.1. Device to Host <PORT#> AXI-ST Subordinate Interface 5.4.2. Device to Host <PORT#> Avalon-ST Sink Interface 5.4.3. Host to Device <PORT#> AXI-ST Manager Interface 5.4.4. Host to Device <PORT#> Avalon-ST Source Interface 5.4.5. Host to Device <PORT#> AXI-4 Manager Interface
6. HAL Driver for DMA SoC Mode  x
6.1. Descriptor Indexing  6.2. HAL Public API 
6.1. Descriptor Indexing  x
6.1.1. Data Descriptors  6.1.2. Responders 
6.2. HAL Public API  x
6.2.1. Software Features 6.2.2. intel_ssgdma.c  6.2.3. intel_ssgdma_global.c 6.2.4. intel_ssgdma_device_port.c  6.2.5. intel_ssgdma_descriptor.c 
7. Parameters x
7.1. DMA Settings 7.2. Device Port Settings 7.3. DMA PCIe Mode Settings 7.4. DMA SoC Mode Settings 7.5. Example Design
7.2. Device Port Settings x
7.2.1. H2D MM 7.2.2. H2D ST 7.2.3. D2H ST
8. Registers x
8.1. Global CSR 8.2. MSI-X Memory Space 8.3. Device Port Control Register
1. Product Discontinuance Notification
2. Terms and Acronyms
3. Introduction
4. Functional Description
5. Interfaces
6. HAL Driver for DMA SoC Mode 
7. Parameters
8. Registers
9. Document Revision History for the Scalable Scatter-Gather DMA Intel® FPGA IP User Guide

7.2.2. H2D ST

Table 118.  H2D ST Parameters
Parameter Range Default Description
Number of H2D ST Device Ports 0 to 8 1

Select the number of physical H2D ST device ports.

The combined device port parameter values must be equal or less than 8.
H2D ST Port <n>
Interface Type of H2D ST Port <n> AXI-ST, Avalon-ST AXI-ST Select the interface type of the H2D ST port.
Data Width of H2D ST Port <n> 8, 16, 32, 64, 128, 256, 512, 1024 64 Host to Device Port <n> Streaming Interface Data Width.
Identification Tag Width of H2D ST Port <n> 1-18 1 Host to Device Port <n> AXI-ST Interface Identification Tag Width. Only applicable when AXI-ST Interface Type is selected.
Enable additional TUSER output for H2D ST Port <n> On or Off On Enable additional TUSER output for H2D ST port. Only applicable when AXI-ST Interface Type is selected.
Enable TUSER to SOP mapping feature for H2D ST Port <n> On or Off On Enable TUSER to SOP mapping feature. When this is enabled, the SSGDMA IP asserts high on the h2d<n>_st_tuser bit[0] at beginning of h2d<n>_st_tvalid cycle to indicate start of packet. This parameter is available only when Enable additional TUSER output for H2D ST port <n> parameter is enabled and AXI-ST Interface Type is selected.
Error Width of H2D_ST Port <n> 0-8 0 Host to Device Port <n> interface error width. When you select AXI-ST Interface Type, the error output is mapped to TUSER output of the port.
Enable PTP Timestamp Input for H2D ST Port <n> On or Off Off Enable 96-bit IEEE 1588 PTP (Precision Time Protocol) timestamp input for H2D ST port.
Level Two Title