File List

Here is a list of all files with brief descriptions:

• dir docs
  • dir sw
    • dir include
      • dir opae
        • file access.h Functions to acquire, release, and reset OPAE FPGA resources.
        • file buffer.h Functions for allocating and sharing system memory with an FPGA accelerator.
        • dir cxx
          • file core.h
          • dir core
            • file errors.h
            • file events.h
            • file except.h
            • file handle.h
            • file properties.h
            • file pvalue.h
            • file shared_buffer.h
            • file sysobject.h
            • file token.h
            • file version.h
        • file enum.h APIs for resource enumeration and managing tokens.
        • file error.h Functions for reading and clearing errors in resources.
        • file event.h Functions for registering events and managing the lifecycle for fpga_event_handle s.
        • file fpga.h FPGA API.
        • file hash_map.h A general-purpose hybrid array/list hash map implementation.
        • file init.h Initialization routine.
        • file log.h
        • file manage.h Functions for managing FPGA configurations.
        • file mem_alloc.h
        • file metrics.h Functions for Discover/ Enumerates metrics and retrieves values.
        • file mmio.h Functions for mapping and accessing MMIO space.
        • file properties.h Functions for examining and manipulating fpga_properties objects.
        • file sysobject.h Functions to read/write from system objects.
        • file types.h Type definitions for FPGA API.
        • file types_enum.h Definitions of enumerated types for the OPAE C API.
        • file uio.h APIs to manage a PCIe device via UIO.
        • file umsg.h FPGA UMsg API.
        • file userclk.h Functions for setting and get afu user clock.
        • file utils.h Utility functions and macros for the FPGA API.
        • file version.h
        • file vfio.h APIs to manage a PCIe device via vfio-pci.
    • dir samples
      • dir hello_events
        • file hello_events.c A code sample of using OPAE event API.
      • dir hello_fpga
        • file hello_fpga.c A code sample illustrates the basic usage of the OPAE C API.