Skip to main content

Amaranth HDL framework for FPGA-based USB solutions

Project description

LUNA: an Amaranth HDL library for USB Simulation Status Documentation Status

LUNA is a toolkit for working with USB using FPGA technology, providing gateware and software to enable USB applications.

Some things you can use LUNA for, currently:

  • Protocol analysis for Low-, Full-, or High- speed USB. LUNA provides gateware that allow passive USB monitoring when combined with Cynthion and Packetry.
  • Creating your own Low-, Full-, High-, or (experimentally) Super- speed USB device. LUNA provides a collection of Amaranth gateware that allows you to easily create USB devices in gateware, software, or a combination of the two.
  • Building USB functionality into a new or existing System-on-a-Chip (SoC). LUNA is capable of generating custom peripherals targeting the common Wishbone bus; allowing it to easily be integrated into SoC designs; and the luna-soc library provides simple automation for developing simple SoC designs.

Some things you'll be able to use LUNA for in the future:

  • Man-in-the-middle'ing USB communications. The LUNA toolkit will be able to act as a USB proxy, transparently modifying USB data as it flows between a host and a device.
  • USB reverse engineering and security research. The LUNA toolkit will serve as an ideal backend for tools like Facedancer; allowing easy emulation and rapid prototyping of compliant and non-compliant USB devices.

Project Structure

This project is broken down into several directories:

  • luna -- the primary LUNA python toolkit; generates gateware and provides USB functionality
    • luna/gateware -- the core gateware components for LUNA; and utilities for stitching them together
  • examples -- simple LUNA-related examples; mostly gateware-targeted, currently
  • docs -- sources for the LUNA Sphinx documentation
  • contrib -- contributed/non-core components; such as udev rules
  • applets -- pre-made gateware applications that provide useful functionality on their own (e.g., are more than examples)

Project Documentation

LUNA's documentation is captured on Read the Docs. Raw documentation sources are in the docs folder.

Related Projects

  • Cynthion: an open source hardware USB test instrument
  • Apollo: the firmware that runs on Cynthion's debug controller and which is responsible for configuring its FPGA
  • Saturn-V: a DFU bootloader created for Cynthion
  • Packetry: software for USB analysis
  • Facedancer: software to create USB devices in Python

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

luna_usb-0.1.2.tar.gz (294.7 kB view details)

Uploaded Source

Built Distribution

luna_usb-0.1.2-py3-none-any.whl (335.8 kB view details)

Uploaded Python 3

File details

Details for the file luna_usb-0.1.2.tar.gz.

File metadata

  • Download URL: luna_usb-0.1.2.tar.gz
  • Upload date:
  • Size: 294.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.16

File hashes

Hashes for luna_usb-0.1.2.tar.gz
Algorithm Hash digest
SHA256 6238dc9b4db85ed0fc797262b153186c44cc7d46b4f2d96db5ae6eff5368578b
MD5 964c75395233fbaca51bc4bd16c5a2cf
BLAKE2b-256 ffc51e705c5e612b125fe62d9c13c9151814c3ad4ec25f9385492e7f36de0361

See more details on using hashes here.

File details

Details for the file luna_usb-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: luna_usb-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 335.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.16

File hashes

Hashes for luna_usb-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 23cbec258723016336a5dbf361c12bd158b7d4c66d98e4a3b641e4cc9e527d10
MD5 77de61879e27538af082a0aa52d09ea9
BLAKE2b-256 2f469305e8bd1d24ef30cf168fece8db010fdbc64f3c20198a265bbf3acb3cca

See more details on using hashes here.

Supported by

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