XIA PZ-TIO User manual

PZ-TIO
User Manual
Version 1.01
April 4, 2022
Hardware Revisions: A
Software Revision: 0x1103
Firmware Revision and Variants:
0xAF00 0x0100 (standard)
XIA LLC
2744 East 11th St
Oakland, CA 94601, USA
Email: [email protected]
Tel: [phone]; Fax: [phone]
http://www.xia.com/
Information furnished by XIA LLC is believed to be accurate and reliable. However, no responsibility is assumed by
XIA for its use, or for any infringements of patents or other rights of third parties which may result from its use. No
license is granted by implication or otherwise under any patent or patent rights of XIA. XIA reserves the right to
change hardware or software specifications at any time without notice.

PZ-TIO Manual Version 1.01
© 2022 XIA LLC 2
Contents
Safety ............................................................................................................................................................ 4
Specific Precautions.................................................................................................................................. 4
Power Source ........................................................................................................................................ 4
User Adjustments/Disassembly ............................................................................................................ 4
Voltage Ratings..................................................................................................................................... 4
Servicing and Cleaning......................................................................................................................... 4
Linux Passwords ................................................................................................................................... 4
Linux Backup........................................................................................................................................ 4
Warranty Statement ...................................................................................................................................... 5
Contact Information: ................................................................................................................................. 5
Manual Conventions ..................................................................................................................................... 6
1Introduction........................................................................................................................................... 7
1.1 PZ-TIO Features ........................................................................................................................... 8
1.2 Specifications................................................................................................................................ 9
1.3 System Requirements.................................................................................................................. 10
1.3.1 Drivers and Software .......................................................................................................... 10
1.3.2 Input Signals ....................................................................................................................... 10
1.3.3 Power Requirements ........................................................................................................... 11
1.3.4 Connectors and Cabling ...................................................................................................... 11
1.4 Software and Firmware Overview .............................................................................................. 11
1.5 Support........................................................................................................................................ 11
2Setup ................................................................................................................................................... 12
2.1 Power .......................................................................................................................................... 12
2.2 Serial Port (USB-UART) ............................................................................................................ 12
2.3 SSH login .................................................................................................................................... 13
2.4 Web Interface.............................................................................................................................. 13
2.5 SMB (Samba).............................................................................................................................. 14
2.6 Required Initial Linux Commands.............................................................................................. 14
2.7 White Rabbit ............................................................................................................................... 14
2.8 Useful Linux Commands ............................................................................................................ 15
2.9 Direct Network Connection between PZ-TIO and a Windows PC............................................. 15
3PZ-TIO Operation............................................................................................................................... 17
3.1 Adjust Parameters ....................................................................................................................... 17
3.2 Data Acquisition Monitoring ...................................................................................................... 17
3.3 User Interface Options ................................................................................................................ 18
3.3.1 Terminal.............................................................................................................................. 18
3.3.2 Terminal and Webpages...................................................................................................... 18
3.3.3 Terminal, SMB and Windows programs ............................................................................ 19
3.3.4 Webpage-Only Operation ................................................................................................... 19
4API functions ...................................................................................................................................... 21
4.1 progfippi...................................................................................................................................... 21
4.2 runstats, cgistats .......................................................................................................................... 21
4.3 Clockprog –not yet implemented ............................................................................................... 22
4.1 monitordaq .................................................................................................................................. 22

PZ-TIO Manual Version 1.01
© 2022 XIA LLC 3
5Web Pages........................................................................................................................................... 23
5.1 index.html ................................................................................................................................... 23
5.2 rspage.html, cgistats.cgi .............................................................................................................. 24
6Parameters in the Settings Files .......................................................................................................... 25
6.1 System Parameters ...................................................................................................................... 25
6.2 Control Parameters...................................................................................................................... 26
7Data Formats....................................................................................................................................... 27
7.1 Status Files (RS.csv) ................................................................................................................... 27
8Registers Visible to Linux ..................................................................................................................28
8.1 Input/Output Registers ................................................................................................................ 28
8.2 Output Registers.......................................................................................................................... 29
9Linux Configuration ........................................................................................................................... 30
9.1 Licensing Information................................................................................................................. 30
9.2 Software Information .................................................................................................................. 30
9.2.1 Ubuntu 18............................................................................................................................ 31
9.2.2 Systemd startup routine to configure FPGAs...................................................................... 31
9.2.3 Other configurations ........................................................................................................... 32
9.3 Other Settings.............................................................................................................................. 32
9.3.1 Static IP address.................................................................................................................. 32
10 Hardware Information......................................................................................................................... 33
10.1 Board Architecture...................................................................................................................... 33
10.2 Connections................................................................................................................................. 33
10.2.1 Data Connectors.................................................................................................................. 33
10.2.2 MMCX Connectors for Clocks and Triggers...................................................................... 34
10.2.3 PMOD and HDMI Connectors for GPIO............................................................................ 34
10.2.4 Test Points........................................................................................................................... 35
10.2.5 Daughterboard Connections................................................................................................ 35
10.3 Clocks ......................................................................................................................................... 36
10.4 Jumpers ....................................................................................................................................... 36
10.5 LEDs ........................................................................................................................................... 37
10.6 IEEE 1588 Precision Timing Protocol........................................................................................ 37
10.6.1 Overview............................................................................................................................. 37
10.6.2 PTP Stack Software: LinuxPTP.......................................................................................... 38
10.6.3 PTP PHY Control Software: ptp-mii-tool........................................................................... 38
10.6.4 Reduced General Purpose Functionality............................................................................. 39
10.7 White Rabbit Hardware Elements............................................................................................... 39
10.8 PicoZed configuration................................................................................................................. 40
11 Software Information.......................................................................................................................... 41
11.1.1 File structure ....................................................................................................................... 41
11.1.2 Parameter Definitions ......................................................................................................... 42
11.1.3 FPGA registers.................................................................................................................... 42
11.1.4 Status Registers –cgi vs file vs page .................................................................................. 42
12 Firmware Information......................................................................................................................... 43
13 Known Bugs ....................................................................................................................................... 44

PZ-TIO Manual Version 1.01
© 2022 XIA LLC 4
Safety
Please take a moment to review these safety precautions. They are provided both for your
protection and to prevent damage to the Pixie module and connected equipment. This
safety information applies to all operators and service personnel.
Specific Precautions
Power Source
The PZ-TIO module is powered through an AC/DC wall adapter. The default adapter has
a variety of AC plug attachments for different localities. Please remember to shut down the
Linux OS before removing the power plug from the PZ-TIO.
User Adjustments/Disassembly
To avoid personal injury, and/or damage, always disconnect power before accessing the
module’s interior. There are a few jumpers related to clocking on the board that
experienced users may want to use.
Voltage Ratings
Signals on the inputs and outputs must not exceed ± 3.3V. Please review the pinout in the
appendix before making any connections.
Servicing and Cleaning
To avoid personal injury, and/or damage to the module or connected equipment, do not
attempt to repair or clean the inside of these units.
Linux Passwords
The PZ-TIO Linux OS comes with default user IDs and passwords for 1) SSH login, 2)
SMB file sharing, and 3) Web Operations as described below. Users should immediately
change these passwords, especially when the PZ-TIO is connected to external networks.
Don’t let hackers take over your PZ-TIO!
Linux Backup
The PZ-TIO Linux OS is stored on a removable SD card. SD cards’ file systems can
become corrupted, which would crash the Linux system and make the PZ-TIO unable to
operate. Therefore periodic backup of the SD card is recommended, for example using
Win32DiskImager. (Byte for byte copy is required).
Note that all Linux passwords are stored on the SD card.

PZ-TIO Manual Version 1.01
© 2022 XIA LLC 5
Warranty Statement
XIA LLC warrants that this product will be free from defects in materials and workmanship
for a period of one (1) year from the date of shipment. If any such product proves defective
during this warranty period, XIA LLC, at its option, will either repair the defective products
without charge for parts and labor, or will provide a replacement in exchange for the
defective product.
In order to obtain service under this warranty, Customer must notify XIA LLC of the defect
before the expiration of the warranty period and make suitable arrangements for the
performance of the service.
This warranty shall not apply to any defect, failure or damage caused by improper uses or
inadequate care. XIA LLC shall not be obligated to furnish service under this warranty a)
to repair damage resulting from attempts by personnel other than XIA LLC representatives
to repair or service the product; or b) to repair damage resulting from improper use or
connection to incompatible equipment.
THIS WARRANTY IS GIVEN BY XIA LLC WITH RESPECT TO THIS PRODUCT IN
LIEU OF ANY OTHER WARRANTIES, EXPRESSED OR IMPLIED. XIA LLC AND
ITS VENDORS DISCLAIM ANY IMPLIED WARRANTIES OF
MERCHANTABILITYOR FITNESS FOR A PARTICULAR PURPOSE. XIA’S
RESPONSIBILITY TO REPAIR OR REPLACE DEFECTIVE PRODUCTS IS THE
SOLE AND EXCLUSIVE REMEDY PROVIDED TO THE CUSTOMER FOR BREACH
OF THIS WARRANTY. XIA LLC AND ITS VENDORS WILL NOT BE LIABLE FOR
ANY INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
IRRESPECTIVE OF WHETHER XIA LLC OR THE VENDOR HAS ADVANCE
NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.
Contact Information:
XIA LLC
2744 East 11th St.
Oakland, CA 94601 USA
Telephone: [phone]
Downloads: http://support.xia.com
Hardware Support: [email protected]
Software Support: [email protected]

PZ-TIO Manual Version 1.01
© 2022 XIA LLC 6
Manual Conventions
The following conventions are used throughout this manual
Convention
Description
Example
»
The » symbol leads you
through nested menu items
and dialog box options.
The sequence
File»Page Setup»Options directs you to pull
down the File menu, select the Page Setup
item, and choose Options from the sub menu.
Bold
Bold text denotes items that you
must select or click on in the
software, such as menu items,
and dialog box options.
...click on the MCA tab.
[Bold]
Bold text within [ ] denotes a
command button.
[Start Run] indicates the command button
labeled Start Run.
Monospace
Items in this font denote text
or characters that you enter
from the keyboard, sections
of code, file contents, and
syntax examples.
Setup.exe refers to a file called “setup.exe”
on the host computer.
“window”
Text in quotation refers to
window titles, and quotations
from other sources
“Options” indicates the window accessed via
Tools»Options.
Italics
Italic text denotes a new term
being introduced , or simply
emphasis
peaking time refers to the length of the slow
filter.
...it is important first to set the energy filter Gap
so that SLOWGAP to at least one unit greater
than the preamplifier risetime...
<Key>
<Shift-Alt-
Delete> or
<Ctrl+D>
Angle brackets denote a key
on the keybord (not case
sensitive).
A hyphen or plus between
two or more key names
denotes that the keys should
be pressed simultaneously
(not case sensitive).
<W> indicates the W key
<Ctrl+W> represents holding the control key
while pressing the W key on the keyboard
Bold italic
Warnings and cautionary text.
CAUTION: Improper connections or settings
can result in damage to system components.
CAPITALS
CAPITALS denote DSP
parameter names
SLOWLEN is the length of the slow energy
filter
SMALL CAPS
SMALL CAPS are used for
panels/windows/graphs in the
GUI.
…go to the MCADISPLAY panel and you see…

PZ-TIO Manual Version 1.01
© 2022 XIA LLC 7
1 Introduction
The PZ-TIO is an input/output carrier board for a Zynq System on Module
1
(SoM). The
Zynq is a combination of an FPGA (Programmable Logic, PL) with an ARM processor
(Processing System, PS). The PL can implement the White Rabbit IP core, and additional
logic to route input and output signals –if desired synchronous with a White Rabbit master
clock to sub-nanosecond precision. The PS can run Ubuntu 18 with gcc, webserver, etc; it
has USB and Ethernet peripherals and 1GB of memory.
The PZ-TIO carrier board connects the PL to ~40 GPIO lines and 3 SFP interface ports.
All of the SFP interfaces can be replaced by GPIO connectors, and two
2
are capable of 1
Gbps Ethernet with White Rabbit time synchronization, when using replaceable
daughterboards for the White Rabbit clocking circuitry. The PS can be accessed via
USB/UART and 10/100/100M Ethernet port (alternatively a PTP
3
compatible 10/100M
Ethernet port).
At this time, the PZ-TIO should not be considered a commercial product. XIA does not
promise any particular functionality or suggests its use as part of a setup for the readout of
radiation detectors
4
, which is XIA’s main line of business. Instead, it should be seen as a
byproduct of recent R&D
5
. In that development, we benefited from a number of freely
available designs and concepts, and their supporting communities. We therefore spent a
little extra time to pull them together in an evaluation board of sorts and make them
available to the community in combination. We provide the PZ-TIO “as is”, but not for
free -- there are real production costs. We will try to answer questions as “moderately
experienced implementers” as time allows, but we are not the creators of, or experts in, the
designs above. At this point, all the PZ-TIO really does is allowing a PicoZed to blink an
LED or toggle an output pin in sync with a White Rabbit or other PTP master. Legally, we
are [probably] only selling a circuit board –not even the PicoZed itself –that may allow
you to run firmware and software you obtain separately. However, the hope is that this is
still useful to other developers.
Note: some functions not fully tested are highlighted in yellow
1
Model Avnet PicoZed 7015
2
Currently only one is tested
3
IEEE 1588 Precision Time Protocol
4
Though it might in the future, with suitable firmware for specific applications
5
See Pixie-Net XL on XIA’s website

PZ-TIO Manual Version 1.01
© 2022 XIA LLC 8
1.1 PZ-TIO Features
The PZ-TIO is designed as a “switchboard” for GPIO signals, synchronized by White
Rabbit, to route input signals to output signals and make logical combinations between
them in FPGA fabric. It has the following features and capabilities:
40+ GPIO connections to PicoZed Zynq SOM
3 SFP interfaces
Supports White Rabbit IP core implementation in PicoZed by providing clocking
circuitry for 2 SFPs (on daughterboards)
Carries PicoZed Zynq processor with embedded Linux, acting as a standalone PC
with built-in SD card drive, USB host, 10/100/1000 Ethernet, webserver, etc
Optional 1588 PTP and SyncE clock synchronization for Linux
Open source user access to hardware, software and firmware

PZ-TIO Manual Version 1.01
© 2022 XIA LLC 9
1.2 Specifications
PL (Fabric) IO connectors
3 SFP
3 SFP connectors for Ethernet I/O, routed to PL GTX pins for data and
generic I/O pins for control.
Generic I/O lines also available on PMOD-style I/O connectors (not
stuffed by default)
7 MMCX
7 MMCX coaxial connectors with input or output buffers for
-Clock input
-Clock output
-Veto Input
-Sync input
-3x Trigger output
The functionality is configurable by jumpers and/or in the firmware.
3 PMOD
3 PMOD-style I/O connectors for direct connection to PL pins
-1 connector is a 12-pin receptacle
-2 connectors are right angle headers (not stuffed by default)
-3.3V power from PZ-TIO to peripheral
1 microHDMI
1 microHDMI for buffered 5V TTL input or output signals
-6 outputs
-7 inputs
-5V power from PZ-TIO to peripheral
-Not used for video
2 Daughtercards
2 High density, 40-pin headers to expand PL functionality
-25 I/O signals, 3.3V power
-Matches XIA’s White Rabbit clocking daughtercard
Power and PS (ARM) IO connectors
Power
12V DC in.
AC adapter requirements: 12V, 10W
Barrel Plug 2.1mm I.D. x 5.5mm O.D., center positive
SD card
16 GB micro SD card (removable)
UART
Micro USB connector for PS UART I/O
2 RJ-45
2 RJ-45 connectors for
-10/100/1000M Ethernet from PicoZed PHY on PS
-Alternative routing of PS Ethernet through PL and PTP
compatible 10/100M PHY.
USB
USB type A for USB host from Zynq PS

PZ-TIO Manual Version 1.01
© 2022 XIA LLC 10
Matching Embedded Processing
Processor
Xilinx Zynq –Avnet PicoZed
Data Interfaces
10/100/1000 Ethernet
USB 2.0 (host)
USB-UART
Memory
1 GB of DDR3 SDRAM
128 Mb of QSPI Flash
4 GB of eMMC memory
Operating System
Linux (Xillinux –based on Ubuntu 18)
Operates from Linux partition on SD card
Firmware and Software Possibilities
Trigger Routing
and Coincidence
Firmware demo code for
-controlling connections between inputs and outputs
-counting input pulses for WR defined time periods
FPGA register
programming
C software to
-program FPGA registers that enable or disable connections.
-read FPGA status registers
Time
synchronization
Clock synchronization with White Rabbit core or DP83640 PTP PHY
C software (LinuxPTP) to operate IEEE 1588 PTP timers and adjust local
clock to network clock master
C software to define PTP timed triggers
Table 1-1. Specifications for the PZ-TIO
1.3 System Requirements
The system considered here consists of a PZ-TIO, a PicoZed, and a White Rabbit switch
(or other PTP master) plus appropriate cabling. Optional connections can be made to
external electronics. A PC, smartphone or tablet is required to communicate with the
PicoZed, but trigger routing and clock synchronization is fully contained in the
combination of PicoZed and PZ-TIO.
1.3.1 Drivers and Software
The PicoZed on the PZ-TIO operates with an embedded Linux system that includes all
software and drivers to communicate with external devices via Ethernet or USB. It can
-Make status information available via webserver
-Read and write USB drives for data exchanges
-Share files over a Windows network
1.3.2 Input Signals
Input signals must not exceed ± 3.3V, except on the 5V compatible GPIO of the HDMI
connector.