Hardware Projects » E1/T1 Hardware Interface (including icE1usb)

h1. iCE40 E1 USB interface

{{>toc}}

!{width:20%}icE1usb-usb_side.jpg!

This page is the main entry point for the (completed!) "Software defined" E1 USB interface using the iCE40 FPGA at its core.

h2. Architecture

This approach tries to implement as much as possible inside an iCE40 FPGA

Particularly, the iCE40 FPGA

* contains the E1 PHY. There is no external LIU*, reducing the BOM cost significantly.  Instead, the comparators of the FPGA are used to detect RX positive / negative pulses and normal CMOS drivers to generate the TX pulses.  In practice, this has shown to work reliably on short E1 links of a few meters.  We'd expect some problems in terms of long-haul E1 links, but those are not really the target use case here.

* contains the E1 framer, including frame alignment, CRC4 verification/generation, ...

* contains a USB softcore (no external USB PHY needed)

* contains a PicoRV32 softcore to implement USB protocol handling and to connect the E1 softcore with the USB softcore

So all-in-all, we can build a USB-E1 interface from little more than an iCE40 FPGA and an E1 line transformer!

{{graphviz_link()

digraph G {

  rankdir = LR;

  BTS -> XFRM [label="E1"];

  Linux [label="Linux\nOsmoBSC"];

  subgraph cluster_A {

    label = "iCE40 E1 USB Interface";

    XFRM [label="Magnetics"];

    XFRM -> Comparators [label="E1 (HDB3)"];

    subgraph cluster_B {

      label = "iCE40 FPGA";

      Comparators;

      Framer [label="E1 Framer\nSoftcore"];

      RISCV [label="RISCV\nSoftcore"];

      USB [label="USB\nSoftcore"];

      Comparators -> Framer [label="E1 (Serial Bits)"];

      Framer -> RISCV;

      RISCV -> USB;

    }

  }

  USB -> Linux [label="Frame-aligned raw\nbits over USB"];

}

}}

h2. Current stack

* The hardware for the first production version is documented in the https://git.osmocom.org/osmo-e1-hardware

* The fpga gateware and associated embedded firmware is hosted in the same git repository. Some parts are in submodules (be sure to use recursive clone)

* The userspace daemon that handles the USB communication is hosted at: https://git.osmocom.org/osmo-e1d

* The support for this daemon interface to the rest of the cellular stack is merged in mainline [[libosmo-abis:]]. Make sure you build it with @--enable-e1d@, though.

h2. Availability

The fully assembled and tested icE1usb hardware is sold by "sysmocom":https://sysmocom.de/ ("product page":https://www.sysmocom.de/products/lab/icE1usb, "data sheet":https://www.sysmocom.de/downloads/icE1_data_sheet.pdf) an can be purchased from the "webshop":http://shop.sysmocom.de/products/icE1usb - hobbyist/community discounts are available.

h2. Presentations

* Talk from OsmoCon 2018 about the Software Defined E1 project as a whole : attachment:osmocon_2018_e1.pdf

* Talk from OsmoDevCon 2019 about the iCE40 based solution specifically: attachment:osmodevcon_2019_e1.pdf

* "video recording of the iC40 based approach / OsmoDevCon 2019":https://media.ccc.de/v/osmodevcon2019-97-software-defined-e1

h2. User Manual

* https://ftp.osmocom.org/docs/latest/icE1usb-usermanual.pdf

h2. Status

h3. Hardware

* First proof of concept was done in 2018, based on manually wired protoboard to prove viability of the USB and E1 interface.

* Several hand-wired pre-production prototypes based on iCEbreaker and iCEbreaker-bitsy have been assembled and used successfully from late 2018 to early 2020

* A fully integrated single-board design with two E1 lines and a GPS-DO for E1 clock stability has been created by @tnt in August 2020. After a couple of prototypes were built and tested, a first production run was made

* fully tested v1.0 units are available since November 2020 through the sysmocom shop.

h3. Firmware / Gateware / Drivers

The full stack from gateware through firmware and host software has been tested and used in a variety of scenarios.

* gateware for the FPGA and firmware for the RISC-V softcore is available from https://git.osmocom.org/osmo-e1-hardware and is buildable using the icestorm OSS toolchain

* The host software/driver is part of [[osmo-e1d:]], see the project page for related details.  [[libosmo-abis:]] has been extended with [[osmo-e1d:]] support.

* There's also a *DAHDI kernel driver for icE1usb* now, see #4923 (and https://git.osmocom.org/dahdi-linux for sources)

Major missing features at this time (December 2021):

* no firmware support for the second line/port yet: #4914

* no firmware support for the GPS-DO peripheral yet: #4672, #4673

* osmo-e1d doesn't re-attach to the USB device after disconnect/reconnect (in DAHDI it works)

Recent binary releases of both gateware can be found below, so you don't have to build them locally :

* "FPGA gateware":https://people.osmocom.org/~tnt/ice1usb/icE1usb-202010-bd399e96.bin ( Flash using @dfu-util -a 0@ )

* "RISC-V firmware":https://downloads.osmocom.org/binaries/icE1usb/firmware/latest/icE1usb-fw.bin ( Flash using @dfu-util -a 1@ )

h2. Credits

The development of FPGA softcores, firmware, PCB schematics, PCB layout and osmo-e1d was done by Sylvain Munaut (@tnt).

h2. Hardware pictures

h3. Early Proof-of-Concept and Prototypes

!{width:45%}proto_poc.jpg!

!{width:45%}ice40-e1.jpg!

h3. Pre-production Prototype

!{width:50%}osmo-e1-ice40.jpg!

h3. Rev 1.0 production

!{width:45%}prod_pcb.jpg!

!{width:45%}prod_batch.jpg!