Breakout Board Guide#

Warning

Always make sure the PC is powered off before connecting or disconnecting the Breakout Board. Neglecting to do this will damage the PCIe Host.

Setup#

The Breakout Board provides access to signals to and from the PCIe host. Each PCIe host is connected to a breakout board using the following connections:

  1. Digital and analog I/O (Required for breakout board operation): A single shrunk delta ribbon (SDR) cable is used for all auxiliary IO and provide power to the Breakout Board.

  2. Headstage links (Required for headstages): A single MMCX coaxial cable is used for each headstage port.

  3. High speed clocks (Optional): A single MMCX caoxial cable is used for each clock signal

  4. HARP (Optional): A 3.5mm audio jack

  5. Configuration (Optional): Micro USB used to update the breakout gateware.

../../_images/breakout_host_connections_callouts.png ../../_images/bb_cables.jpg

Refer to the PCIe Host documentation for a detailed description of how each of these signal lines are acquired.

Note

There may be more IO present on the breakout board than is available on a particular host board. For instance, PCIe Host has two coaxial links, but the breakout board provides four. This is is by design. The breakout is designed to be compatible with future host hardware.

SDR Cable#

Plug in the SDR cable for analog and digital I/O.

../../_images/breakout_IO_cable.jpg

  • Use the SDR to SDR 26 POS cable to connect the Breakout Board to the PCIe host board.

  • Though one end of this cable is marked with ‘camera’, the cable is symmetrical for our purposes, so it can be connected in either direction.

  • The Breakout Board will power on soon after the SDR cable connected to an active host

    Attention

    Some boards have a bug in the power on sequence that means a reset is required before the board will work. This has been fixed in later revisions. If the RGB LEDs remain off after plugging in the SDR cable, reset the Breakout Board by inserting a thin wire or screw driver into the small hole just below the ‘Digital Out’ marking to reset the onboard FPGA.

MMCX Cables#

Plug in MMCX coaxial connections for headstage ports and clock signals.

../../_images/MMCX_cable.jpg

  • Use the MMCX to MMCX cable to connect a headstage port on the PCIe Host to the breakout board. A single cable is required for each headstage port.

  • Make sure that port letter (A, B, C, D) on the breakout matches the port letter on the PCIe host.

  • Additional MMCX cables can be used to connect the optional clock IO ports on the PCIe host board to the clock ports on the breakout board. These are passive, 50-ohm transmission lines so the order does not matter.

Warning

The MMCX connectors can be damaged if they are removed improperly. See this link for information on how to connect and remove MMCX cables without damaging the connector.

LEDs#

RGB LEDs indicate various port states, signal directions, digital signals, and acquisition states, etc. The following diagrams provide definitions for each LED color on the breakout board.

../../_images/rgb-leds_callouts.png

Indication LED legend. Half-filled circles indicate a flashing LED. An error status on a headstage port indicates a loss of lock during acquisition. The headstage connection must be re-established and acquisition restarted.#

Buttons#

Buttons can be used to log various experimental events and turn on and off the indication LEDs. The button state is sent with digital data to the PCIe Host. Pressing a button sends a single event per change in button state. Holding a button will not result in repeat presses as a keyboard would. Each button sets one bit in a 6-bit word. For exampled

000001:

Button 0 pressed (integer value 1)

100001:

Button 0 and button 5 pressed (integer value 33)

111111:

All buttons pressed (integer value 63)

Additional, pressing button 0 will toggle indication LED power. This allows all LEDs to be completely turned off for light-sensitive experiments.

../../_images/buttons_labelled.png

Numbers show integer value transmitted to host from pressing each. The first button also controls the illumination state of the indication LEDs on the breakout board.#

Gateware#

The breakout board contains a TinyFPGA BX (Lattice ICE40 breakout board) for digital input serialization, digital output deserialization, interpreting user input, and driving indication LEDs. The breakout board gateware is impelemented using an open-source toolchain (Yosys and NextPnR).

Updating the Gateware#

If Open Ephys team have provided you with an updated firmware file for the Breakout Board, the micro-USB port on the Breakout Board (labelled ‘config’) can be used to update the firmware on the board.

Todo

Link and instructions