Skip to main content

A package manager for FPGA/HDL development: resolve, fetch and assemble IP cores from the LibFPGA registry.

Project description

lfpga

A package manager for FPGA/HDL development. Resolve, fetch and assemble open IP cores from the LibFPGA registry into a source list your simulator or synthesis tool can consume.

The registry is the pypi.org of FPGA IP: curated, ownership-claimed, and toolchain-verified. lfpga is the pip, and its superpower is that every package can carry an earned verification badge (lints clean, synthesizes, testbench passes).

$ lfpga init my-soc
$ lfpga add libfpga
Found libfpga: https://github.com/libfpga/libfpga
  license MIT · verilog · ✓ lint, synth, testbench, formal
$ lfpga add picorv32
$ lfpga install
  libfpga        a4ef4a3fa4ac  1 files  ✓ lint, synth, testbench, formal
  picorv32       e9c4c5b8...   1 files  unverified

Wrote lfpga.lock and build/sources.f (2 source files).

Then point your tool at the generated filelist:

$ verilator --lint-only -f build/sources.f
$ iverilog -o sim.vvp -f build/sources.f
# Vivado: read_verilog -f build/sources.f (via -f)

Why a package manager for FPGA is different

FPGA IP is source, not binaries: there is no ABI and no linking, so lfpga vendors declared HDL files and hands them to the tool of your choice. It does not replace your simulator or synthesizer; it produces the inputs they expect. See the design notes for the full rationale (name collisions, fuzzy versioning, filesets, vendor primitives).

Install

pip install lfpga        # Python 3.11+

Commands

Command What it does
lfpga init [name] Create a libfpga.yaml here
lfpga add <pkg> Add a dependency (name, name@rev, or a git URL)
lfpga install Resolve, pin (lfpga.lock), fetch, and write build/sources.f
lfpga list Show the locked dependencies and their badges
lfpga sources [--format verilator] Emit the assembled source list
lfpga sim [--tool iverilog|verilator] Run a simulation (deps + your testbench)
lfpga synth [--top M] Synthesize with Yosys and report area
lfpga import <.core|Bender.yml> Import a FuseSoC or Bender project

The manifest (libfpga.yaml)

One file, like Cargo.toml: it both declares your dependencies and (if you publish) describes this repo as a package for the registry.

name: my-soc
dependencies:
  libfpga: "*"                       # latest default branch
  picorv32: { rev: v1.0.3 }          # pin a tag, branch or commit
  libfpga-myhdl: { modules: [lfpga_mac] }   # sub-select from a repo
  private-mac: { git: "https://github.com/acme/mac.git" }

The lockfile (lfpga.lock)

Commit it. Because HDL builds are source-and-elaborate, reproducibility is lockfile-first: it pins the exact commit and the exact build sources, so a build is identical across machines and over time.

Status

Phase 2: everything in Phase 1 plus lfpga sim (Icarus/Verilator) and lfpga synth (Yosys) that actually build from the resolved sources, sim/synth filesets, and import from FuseSoC .core and Bender.yml. On the roadmap: Edalize backends for vendor flows, and lfpga publish gated by the verification toolchain.

MIT licensed. Part of LibFPGA.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lfpga-0.3.0.tar.gz (20.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lfpga-0.3.0-py3-none-any.whl (20.7 kB view details)

Uploaded Python 3

File details

Details for the file lfpga-0.3.0.tar.gz.

File metadata

  • Download URL: lfpga-0.3.0.tar.gz
  • Upload date:
  • Size: 20.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for lfpga-0.3.0.tar.gz
Algorithm Hash digest
SHA256 7b2266ae92d60594948f8b7ef761c61166e45761d7d1ca6f08128e7c1271dc23
MD5 0050bdc5e7b57066a373db222cbb27fc
BLAKE2b-256 43ad02472f707feaf425f53ccbd4dbbabfa4d21ae769531f10ac271e8b0a22f9

See more details on using hashes here.

Provenance

The following attestation bundles were made for lfpga-0.3.0.tar.gz:

Publisher: publish.yml on libfpga/lfpga

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lfpga-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: lfpga-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 20.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for lfpga-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 761eb72e58f93d72f8b843ca86566d277107ba625e59baef3734547807567606
MD5 fdca0939b56e8be0f6d7cba318be7c58
BLAKE2b-256 61158a882b78ae3e0a6961f236e1befc4b7a1ba816ae8175baeed1714b73422e

See more details on using hashes here.

Provenance

The following attestation bundles were made for lfpga-0.3.0-py3-none-any.whl:

Publisher: publish.yml on libfpga/lfpga

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page