Private Island ® is an open source FPGA-based project for Ethernet networking. It's primary purpose is for building an open, trustworthy, and extensible foundation for packet processing, IoT, test & measurement, and control (e.g., sensors, motors, etc.) applications.
When the FPGA filters / detects specific addresses, ports, protocols, and data, we are able to confirm at the hardware layer that this has been accomplished. This is in stark contrast to off-the-shelf SoC implementations, which require developers & users to make assumptions of multiple layers (typically opaque) being free of bugs, back doors, and resident spies / spyware.
The open FPGA-based architecture supports numerous, highly parallel functions implemented at Ethernet line rate (125 MHz x 8-bit).
The source code is hosted here.
Soft Gigabit / 100 Mbit Ethernet switch
Real-time packet detection, filtering, inspection, and mirroring
Gigabit Ethernet MAC controller for external micro controller
Customizable metrics. Stream them to the host of your choice.
Dozens of expansion I/O
It's an FPGA and open source, so the applications are endless.
The figure below shows a block diagram of the FPGA Verilog modules comprising a typical Private Island instantiation. Note that the SERDES/PCS functionality is typically provided by a hard macrocell inside an FPGA. The receive (rx) path is into the soft Ethernet switch, and the transmit path is out of the switch.
Strive for modularity and simplicity
Extensible: add new generators, receivers, and packet forwarding
Limited number of dependencies and only when necessary
Enable connecting new modules for new applications
Deterministic packet visibility from inside and outside the FPGA
The figure below shows the Lattice Diamond IDE with the Physical Viewer window enabled. This viewer shows the routing of an instantiation of Private Island ® with one of the wires of the Ethernet rx_data bus highlighted.
The next figure shows the Lattice Diamond Reveal Analyzer active with a trace of the Ethernet receive path. This gives new meaning to the concept of packet inspection and enables developers to see packets within their FPGA as it traverses their device.
Please submit all Git patches to firstname.lastname@example.org. An acceptable flow is defined below:
- Unless the patch is trivial or documentation related, make sure the changes are tested and describe the tests within your commit.
- Install git-email. See git-scm.com reference
- Set up necessary Git config records for user (e.g., name) and sendemail (e.g., smtpserver)
- Create your commit in your local clone against the most recent commit of the master branch.
- Within your commit, clearly state what has been changed, why it was necessary, and how it was tested. Follow best Git practices (references to be added).
- The first line of commit should provide a clear summary using the following template: "<module>: changes to <module>" (e.g., switch: optimize tx prioritization)
- On the command line, execute: git format-patch -1 --subject-prefix='private-island][PATCH'. The prefix will add the following to the commit subject line: [private-island][PATCH]
- email patch using "git send-email" as shown in the example below.
$ git send-email --to email@example.com --suppress-cc=all <commit subject>.patch
If you have questions about the process on patching the Private Island repo, please email us at firstname.lastname@example.org and prefix the subject with "[private-island][Question]"