Programmer’s Guide

• 1. Common Libraries
  • 1.1. Introduction
  • 1.2. Libraries Details
    • 1.2.1. DAO Logger
    • 1.2.2. DAO Utilities
    • 1.2.3. DAO DMA
    • 1.2.4. DAO Bitmap Helper
    • 1.2.5. DAO Assert Helper
• 2. DMA Library
  • 2.1. Initialization
  • 2.2. Packet Processing
• 3. Ethernet Transport Library
  • 3.1. Architecture Overview
  • 3.2. API Usage
  • 3.3. Transport Protocol
    • 3.3.1. TRS header format
    • 3.3.2. TRS packet format
  • 3.4. Usage Restrictions
• 4. Flow Library
  • 4.1. Introduction
  • 4.2. Flow Rule
  • 4.3. Programming Model
    • 4.3.1. Initialization
    • 4.3.2. Flow Creation
    • 4.3.3. Flow Lookup
    • 4.3.4. Flow Destruction
    • 4.3.5. Flow Query
    • 4.3.6. Flow Flush
    • 4.3.7. Flow Information
    • 4.3.8. Installing flow directly into hardware
    • 4.3.9. Removing a flow from hardware
• 5. Liquid Crypto Library
  • 5.1. Architecture Overview
  • 5.2. Features
    • 5.2.1. Asymmetric Cryptography
    • 5.2.2. Symmetric Cryptography
  • 5.3. Control Plane
    • 5.3.1. Setup Device and Queues
    • 5.3.2. Device Teardown
    • 5.3.3. Command Queue
  • 5.4. Data Plane
    • 5.4.1. Enqueue API - Asymmetric Crypto
    • 5.4.2. Enqueue API - Symmetric Crypto
    • 5.4.3. Dequeue API
  • 5.5. Known Limitations
• 6. Netlink Library
  • 6.1. Introduction
  • 6.2. Native netlink registration
    • 6.2.1. Netlink protocols
      • 6.2.1.1. Netlink Object
    • 6.2.2. Native parse callbacks
    • 6.2.3. Netlink multicast groups
    • 6.2.4. Notifier Object
      • 6.2.4.1. Application specific ops
      • 6.2.4.2. Application specific cookie
      • 6.2.4.3. Get notifier object for a given parse_cb
  • 6.3. High level netlink registration
    • 6.3.1. NETLINK_ROUTE
    • 6.3.2. NETLINK_XFRM
  • 6.4. Programming model
    • 6.4.1. Initialization
    • 6.4.2. Periodic Netlink polling
      • 6.4.2.1. dao_netlink_poll()
      • 6.4.2.2. dao_netlink_poll_complete()
      • 6.4.2.3. Pseudo-code
    • 6.4.3. Netlink Cleanup
• 7. PEM Library
  • 7.1. Prerequisites:
  • 7.2. Device Identification
  • 7.3. Device Initialization
  • 7.4. Memory regions registration for polling
  • 7.5. Get VF specific bar region info
• 8. Port Group Library
  • 8.1. Introduction
  • 8.2. Programming model
    • 8.2.1. Initializing Port group library
    • 8.2.2. Creating a Port Group
    • 8.2.3. Adding port to a Port Group
    • 8.2.4. Number of ports in Port group
    • 8.2.5. Port group lookup by name
    • 8.2.6. Iterating over Port group
    • 8.2.7. Deleting port from Port group
    • 8.2.8. Destroying a Port group
• 9. Port Queue Group Library
  • 9.1. Introduction
  • 9.2. Programming model
    • 9.2.1. Initializing Port queue group library
    • 9.2.2. Creating a Port queue group
    • 9.2.3. Assigning [port, queue] to a core within Port queue group
    • 9.2.4. Number of [port, queue] in Port queue group
    • 9.2.5. Port queue group lookup by name
    • 9.2.6. Iterating over Port queue group on fast path core
    • 9.2.7. Deleting port from Port queue group
    • 9.2.8. Destroying a Port queue group
• 10. VFIO Library
  • 10.1. Prerequisites for Platform Devices:
  • 10.2. Prerequisites for PCIe Devices:
  • 10.3. DAO VFIO device initialization
  • 10.4. DAO VFIO device cleanup
• 11. VirtIO Library
  • 11.1. VirtIO Device initialization
  • 11.2. Features
• 12. VirtIO Net Library
  • 12.1. Features
    • 12.1.1. VirtIO Common Feature Bits:
    • 12.1.2. VirtIO-net Feature Bits:
  • 12.2. VirtIO Emulation Architecture Overview
  • 12.3. VirtIO-net device identification
  • 12.4. Device initialization
  • 12.5. User callback APIs
  • 12.6. Queue count
  • 12.7. Link status update
  • 12.8. VirtIO descriptors Management API
  • 12.9. Enqueue Burst API
  • 12.10. Dequeue Burst API