Developer Guides

Guides aimed at contributors extending pyadi-dt — new device classes, eval-board composites, FPGA-platform definitions, and XSA board builders.

• Authoring a new device class
  • 1. Overview & scope
  • 2. Class hierarchy at a glance
  • 3. End-to-end call flow
  • 4. Anatomy of a Device
  • 5. Port & clock-output plumbing
  • 6. Converter patterns
  • 7. Cookbook 1 — Adding a new clock device
  • 8. Cookbook 2 — Adding a new converter / transceiver
  • 9. Cookbook 3 — Adding an eval board or an FPGA board
  • 10. Bridging to the XSA pipeline
  • 11. Testing your new device
• pyadi-jif to pyadi-dt interface contract
  • Status
  • Why a contract is needed
  • Contract decision
  • Ownership boundary
  • Interchange example
  • Binding semantic intent to a board
  • Runnable examples
  • Required validation
  • Proposed producer API
  • Proposed consumer API
  • Errors
  • Test agreement
  • Compatibility policy
  • Rollout
• Hardware CI
  • Discovery and test selection
  • Runner preparation
  • Exporter service
  • Generated-DTB deployment
  • Local runs and evidence
  • Local DT-emission parity
  • Troubleshooting
• Release hardware validation
  • 0.1.0 candidate (2026-09-17)
  • 2026-09-05 qualification
• Labgrid exporter systemd service
  • Convention
  • Installation
  • Installer options
  • Day-to-day operation
  • Migrating from the older templated scheme
• Release Operator Runbook
  • One-time setup
  • Prepare and validate
  • Tag and publish
  • Verify the published release
  • Recover from partial failure
• Runtime JESD overlay validation
  • Build private test kernels
  • Select artifacts for labgrid
  • Provisioned release runners
• Release readiness audit — 2026-09-05
  • Confirmed defects addressed
  • Software verification
  • Initial hardware evidence (superseded by final qualification)
  • Reproducible test artifacts
  • Release scope and retained limitations
  • Retained evidence
  • Applicable-hardware follow-up
  • Non-AD9081 completion follow-up