All things SMASH¶
Scope of this Document
This document describes the low level functionality of the SERENITY Board (e.g. how to power parts on and off and also create a Xilinx Virtual Cable (XVC) to upload firmware to the daughter cards). For general (and first time) usage of the SERENITY it is suggested to follow these instructions: SERENITY first steps. The Useful Commands section describes basic operation such as powering on daughter cards and checking the status of devices on the board, along with instantiating the XVC (Xilinx Virtual Cable) for uploading bit files. The Advanced Usage page describes the plethora of commands available within SMASH and the ways in which to deploy them including clock configuration (jitter cleaners) and Fireflys.
All content is covered by the Serenity Collaboration Licence (CC BY-NC-ND 4.0).
- An overview of SMASH: The Serenity MAnagement SHell
- Useful Commands
- Advanced Usage
- Set up the local environment
- Detailed Commands
- Power On or Off both of the processing FPGAs
- Configure both the SI5345 clock jitter cleaners on an interposer
- Status Checks
- Apply multiple configuration files within one directory (alphanumeric order):
- To connect a DC to the JTAG header:
- Tunnel to run XVC through a port forward
- Voltage and Current Measurements
- Example Configuration File:
- Locate Command:
- Firefly Configuration:
- Firefly Hard Reset:
- Firefly High-Speed
- List Available Options in SMASH
- Full Command Set for SMASH
- Core – Abstract Base Elements
- Core Elements
- Components
- AT24CS02
- AT24MAC602
- BCM53134
- DaughterCard
- DaughterCardSocket
- DummyComponent
- Firefly
- FireflyPassive
- FireflySocket
- Ftdi
- IPbusI2Cmaster
- IPbusI2Cmux
- IPbusJTAGmaster
- IPbusJTAGmux
- IPbusSPImaster
- JTAGheader
- LTM4677
- LTgroup
- Max6639
- NDM2Z
- NDM3Z
- PCAL6524
- PowerGroup
- QSFP
- QSFPsocket
- Si53156
- Si5345
- TLC59208
- XilinxFPGA
- Release notes
- Version 0.6.1
- Version 0.6.0
- Version 0.5.2
- Version 0.5.1
- Version 0.5.0
- Version 0.4.0
- Version 0.3.8
- Version 0.3.7
- Version 0.3.6
- Version 0.3.5
- Version 0.3.4
- Version 0.3.3
- Version 0.3.2
- Version 0.3.1
- Version 0.3.0
- Version 0.2.9
- Version 0.2.8
- Version 0.2.6
- Version 0.2.5
- Version 0.2.4
- Version 0.2.3
- Version 0.2.2
- Version 0.2.1
- Version 0.2.0
- Version 0.1.4
- Version 0.1.3
- Version 0.1.2
- Version 0.1.1
- Version 0.1.0
- Very Advanced Usage
Status of this Document¶
First steps to using the SERENITY prototype system.
Rev 1.0: First version - Alex Howard, 9th April 2019.
Rev 2.0: First Commands - Greg Iles, June 2019.
Rev 3.0: Advanced Commands - Alex Howard, 2nd July 2019.