Documentation Overview for Agilex 7 PCIe Attach Reference Designs

Use this page as a guide to understand how to navigate the documentation depending on your role:

Document	Description	Board Developer	Shell Developer	Workload Developer	Software Developer
Board Installation Guide: OFS for Acceleration Development Platforms	Describes how to install the N6000/N60001 platform in a server with required cabling and configure BIOS	X	X
Board Installation Guide: OFS for Agilex® 7 PCIe Attach Development Kits	Describes how to install evaluation kits in a server with required cabling and configure BIOS	X	X
Software Installation Guide: OFS for PCIe Attach FPGAs	Provides steps for installing Linux kernel packages and OPAE software development kit package	X		X	X
Getting Started Guide: OFS for Agilex® 7 PCIe Attach FPGAs (I-Series Development Kit (2xR-Tile, 1xF-Tile))	Provides steps for loading a pre-packaged PCIe attach shell binary unto the I-Series Development Kit and using the OPAE user space tools		X	X
Getting Started Guide: OFS for Agilex® 7 PCIe Attach FPGAs (F-Series Development Kit (2xF-Tile))	Provides steps for loading a pre-packaged PCIe attach shell binary unto the F-Series Development Kit and using the OPAE user space tools		X	X
Getting Started Guide: OFS for Agilex® 7 PCIe Attach FPGAs (Intel® FPGA SmartNIC N6001-PL/N6000-PL)	Provides steps for loading a pre-packaged PCIe attach shell binary unto the Intel FPGA SmartNIC N6000/1-PL platform and using the OPAE user space tools		X	X
Automated Evaluation User Guide: OFS for Agilex® 7 PCIe Attach FPGAs	Describes how to use provided automated script to step through setup, build flows, simulation and OneAPI tasks. Script can be leveraged for your own custom builds.		X	X
PCIe Attach Shell Technical Reference Manual	Describes features and functions of the Agilex 7 PCIe attach reference design for the Intel FPGA SmartNIC N6000-PL Platform	X
Shell Developer Guide: OFS for Agilex® 7 PCIe Attach (2xR-tile, F-tile) FPGAs	Provides explanation of the shell reference designs targeting the I-Series Development Kit and steps for building and modifying the design		X
Shell Developer Guide: OFS for Agilex® 7 PCIe Attach (2xF-tile) FPGAs	Provides explanation of the shell reference design targeting the F-tile Development Kit and steps for building and modifying the design		X
Shell Developer Guide: OFS for Agilex® 7 PCIe Attach (P-tile, E-tile) FPGAs	Provides explanation of the shell reference design targeting the Intel FPGA SmartNIC N6000-PL platform and steps for building and modifying the design		X
Hard Processor System Software Developer Guide: OFS for Agilex® FPGAs	Provides steps for building or using pre-compiled ITB images for exploration and evaluation of the HPS bring-up flow on the Intel FPGA SmartNIC N6000/1-PL platforms.		X		X
UVM Simulation User Guide: OFS for Agilex® 7 PCIe Attach	Describes how to use the provided UVM environment files and test suite to simulate the default reference designs		X
Workload Developer Guide: OFS for Agilex® 7 PCIe Attach FPGAs	Describes how to build, test and debug an example workload for a PCIe attach shell.			X
PIM Based AFU Developer Guide	Describes how to create a an AFU/workload using the Platform Interface Manager (PIM) shims			X
AFU Simulation Environment User Guide	Provides steps for using the AFU Simulation Environment for hardware/software co-simulation of your workload			X
oneAPI Accelerator Support Package (ASP): Getting Started User Guide	Provides steps to use and test with the default OneAPI Accelerator Support Package			X
oneAPI Accelerator Support Package(ASP) Reference Manual: Open FPGA Stack	Provides details about the hardware and software components required for enabling OneAPI in OFS designs.			X
Software Reference Manual: Open FPGA Stack	Provides details of OPAE SDK user-space software stack and the kernel-space linux-dfl drivers				X
KVM User Guide: Open FPGA Stack	Describes how to setup and configure a virtual machine in an OFS-enabled design			X	X
Docker User Guide: Open FPGA Stack	Provides steps for implementing a docker container to evaluate and develop with OFS		X	X	X
Document	Description	Board Developer	Shell Developer	Workload Developer	Software Developer