Page 2
ALL WARRANTIES, EITHER EXPRESS OR which is embodied in its End User License met. IMPLIED WITH REGARD TO THIS MANUAL Agreement (EULA), a copy of which can AND ANY INFORMATION CONTAINED M5200A PXIe Digitizer Modules Startup Guide...
Search field at the top of the page. Do not use the device if it is damaged. Contact your Keysight WARNING sales representative for replacement of device. Verify that all safety precautions are taken. Make all connections WARNING to the unit before applying power.
Page 4
Normally only dry non-conductive pollution occurs. Occasionally a temporary conductivity caused by condensation may occur. Example: General indoor environment. Conductive pollution occurs, or dry, non-conductive pollution occurs which becomes conductive due to condensation which is expected. Example: Sheltered outdoor environment. M5200A PXIe Digitizer Modules Startup Guide...
Keysight in addition to product takeback instructions. Declaration of Conformity Declarations of Conformity for this product and for the Keysight products may be downloaded from the Web. Go to http://www.keysight.com/go/conformity. You can then search by product number to find the latest Declaration of Conformity.
In this Guide This guide provides you the information to begin using the M5200A PXIe Digitizer Modules. • Chapter 1, “Overview on M5200A PXIe Digitizer modules” provides an overview of the M5200A PXIe Digitizer Module hardware and software along with an overview of the applications that enhance the module’s functionality.
Safety symbols & instrument markings Compliance and Environmental Information Declaration of Conformity In this Guide 1 Overview on M5200A PXIe Digitizer modules About this document About M5200A PXIe Digitizer modules About products supported with M5200A modules About M5200x software features...
Page 10
Contents 2 Setting up the M5200A module Unpacking, Inspecting and Verifying the shipment Precautions against ESD Verifying shipment of M5200A module Inspecting for damage Returning the Module for Service Installing the PXIe Module Before Installing the Module Preparing the PXIe Chassis...
Page 11
Installing Python after the Instrument Driver Troubleshooting issue with launching SFP Troubleshooting issues with PathWave FPGA Module-specific BSPs not installed Xilinx Vivado tool not installed Timing errors during k7z file generation Safety information General safety considerations M5200A PXIe Digitizer Modules Startup Guide...
Page 13
PXIe Digitizer modules / 14 About this document / 15 About M5200A PXIe Digitizer modules / 18 About products supported with M5200A modules / 21 About M5200x software features / 22 About PathWave FPGA and BSP / 24 About KS2201A PathWave Test Sync Executive software...
M5200A PXIe Digitizer module along with its associated software components. It also serves as a guide for the required preliminary setup followed by procedures to install the Keysight M5200A PXIe Module SFP and API along with its extended components. M5200A PXIe Digitizer Modules Startup Guide...
The M5200A is a single-slot PXIe module. Figure 1 shows the front view of an actual physical M5200A module that can be procured. Figure 1 Front view of an M5200A High-speed PXIe Digitizer module M5200A PXIe Digitizer Modules Startup Guide...
Page 16
65 dBc up to 1 GHz 40 dBc up to 2 GHz Supported PXIe Chassis M9046A The input and output flow in the M5200A High-speed PXIe Digitizer is shown in Figure 2. It has a System Link I/O connector synchronization and sequencing, four bi-directional SMB I/Os, four Channels with single-ended analog input SMA connectors, and two connectors for 2.4 GHz clkout and...
Page 17
Overview on M5200A PXIe Digitizer Modules Figure 2 Functional depiction of the M5200A module Use caution when mating high-density connectors to ensure proper CAUTION alignment and prevent damage to the contacts. M5200A PXIe Digitizer Modules Startup Guide...
Infiniium UXR-Series Oscilloscope: 16 GHz, 4 Channels UXR0164A * You may use any External Controller of your choice. Keysight recommends using the HP Z8 G4 Workstation to scale up your system for multi-chassis operations. M5200A PXIe Digitizer Modules Startup Guide...
Page 19
• M9023A PXIe High Performance System Module • Y1201A PCIe cable The M5000-series modules require specific Keysight cables that have been customized for connectivity with the M9032x SSM modules and M9046A PXIe high-performance chassis. Table 4 lists the cables that you may procure for the configuration of a single/multi-chassis multi-system setup.
Page 20
Overview on M5200A PXIe Digitizer Modules When configuring with the M9046A-QS1 option, all cables must be the NOTE same length to ensure proper functioning of the clocking mechanism. The complexity of your quantum computing system shall determine the quantity of modules and cables that should be procured.
Section 1.4: About M5200x software features The Keysight M5200x software, which comprises of drivers, programming libraries and Software Front Panel for the M5200A module, provides a comprehensive platform to perform the basic operations pertaining to Digitizer modules. The M5200x software also supports the Hardware FPGA reprogramming, which is done using the PathWave FPGA Board Support Package.
PathWave FPGA provides a complete FPGA design flow from design creation to simulation to GateWare deployment to Hardware/Gateware verification. This environment provides an easy-to-use GUI, where you may create bitstream images targeted to a sandbox in the Keysight FPGA. Refer to Downloading required software on page 53 for information about Keysight’s landing page for PathWave FPGA software installer.
Page 23
PathWave FPGA software. Both PathWave FPGA software and the BSP function together and cannot be used individually. To control the front panel IO on the M5200A modules, the M5200x API allows you to control the hardware. For more information regarding the PathWave FPGA interface available for the Board Support Package corresponding to the M5200A module, refer to the respective help file embedded in the PathWave FPGA software.
When creating an HVI, you can include any instrument, similar to Keysight’s M5200A PXIe Digitizer modules, that have HVI support. M5200A PXIe Digitizer Modules Startup Guide...
2022 1.0.43106 or greater *Firmware upgrade/downgrade and M5200x software upgrade/downgrade can be performed manually. There is no need to return the module to Keysight. 1.6.3: About HVI Application Programming Interface The HVI Application Programming Interface (API) is the set of programming classes and methods that allows the user to create and program an HVI instance.
Page 26
Overview on M5200A PXIe Digitizer Modules When Keysight M5200x is installed on a PXI system, it installs the drivers required to interact with the M5200A modules. Additionally, the graphical environment for the Keysight M5200x SFP provides a visual representation of most of the M5200x API’s features.
Inspect the carton carefully for any damage, or signs of rough handling. Remove the M5200A module from the packaging container and ensure that all accessories are included. Inspect the module and accessories for damage. If the contents appear damaged, notify your local Keysight Technologies Inc.
(Refer to the warranty information at beginning of this document). To avoid damage when handling the M5200A module, do not touch CAUTION exposed connector pins.
Setting up the M5200A module 2.1.4: Returning the Module for Service If you find it necessary to return the M5200A module for repair or service, follow the steps below: The M5200A is factory tested, aligned, adjusted, and shipped as a single NOTE module.
• To maintain proper airflow within the chassis, all empty chassis slots must be fitted with slot blockers (Keysight model Y1212A, 5 per kit) and EMC filler panels (Keysight model Y1213A, 5 per kit). This includes any empty slots to the left of slot 1.
• If you have multiple M5200A modules and space is available in your chassis, leave an empty slot between modules to enhance airflow. Ensure that a slot blocker and a filler panel are installed in the empty slots.
Do not power up the controller until instructed to do so later in this CAUTION document. Figure 6 Front panel view of M9037A Embedded Controller If your configuration contains a Keysight Embedded Controller (for example, M9037A), follow the procedure below. For additional details, refer to the instructions in the M9037A Startup Guide.
Page 36
Tighten the module retaining screws (top and bottom) and torque them to 5 Lb-In (0.57 N-m). Install a blank Y1213A filler panel in the empty slot to the left of the controller. Connect peripherals (mouse, keyboard, and monitor). M5200A PXIe Digitizer Modules Startup Guide...
PCIe cable. The remote controller can be a desktop PC, a laptop PC, or a rack-mounted PC. If your configuration contains a Keysight Cable Interface module, follow the procedure below. The following procedure addresses using a cabled PCIe interface NOTE between the chassis and an external host computer.
Connect the Interface module to your laptop or desktop PC. 2.2.5: Installing Slot Blockers and Filler Panels To assure proper operating temperatures, install slot blockers (Keysight model Y1212A, 5 per kit) and EMC filler panels (Keysight model Y1213A, 5 per kit) in empty module slots. 2.2.6: Installing the Module Plan your module position.
The temperature LED, which is on for the first three seconds after the chassis is powered up, can be used as an indicator of when to power on the PC. When the LED goes off, the PC can be powered on. Power on the PC. M5200A PXIe Digitizer Modules Startup Guide...
2.2.8: Installing required software After the PC boots up and Windows desktop appears, you must install the software required for programming the M5200A modules. See Chapter “Setting up the M5200x software”. M5200A PXIe Digitizer Modules Startup Guide...
Setting up the M5200A module Section 2.3: Verifying M5200A module’s operation The operation of the M5200A module must be verified after you ensure that all required software is installed, the chassis is powered on, and all cabling is correct. 2.3.1: Verifying M5200A connection The Keysight Connection Expert (installed with IO Libraries Suite) helps you check the connection of the M5200A PXIe Digitizer modules.
Page 42
M5200A module connection status. Click Start > Keysight M5200x PCIe Module > M5200x SFP (x64). The “Connect to Instrument” window appears by default and if connected, it displays the M5200A modules along with the respective slots and VISA address. Figure 11...
Setting up the M5200A module 2.3.2: Conducting Self test The next step in this process is to conduct a Self Test of the M5200A module. Click Start > Keysight M5200x PCIe Module > M5200x SFP (x64) to launch the M5200x SFP.
Page 44
Starting Self test on the selected M5200A module If the self test is successful, the Self Test window appears as shown below. Figure 15 Self test passed status on the selected M5200A module Click Close to exit the Self Test window. M5200A PXIe Digitizer Modules Startup Guide...
Page 45
Setting up the M5200A module If the Self Test fails, it indicates that the module likely needs service. In such cases, you must return the faulty module. Refer to “Returning the Module for Service” on page 32. M5200A PXIe Digitizer Modules Startup Guide...
Power off the chassis and remove the M5200A module. Use either a dry lint free cloth, or compressed air to clean the front plate (face-plate) only of the M5200A module.
Table 8 Software to be installed prior to M5200x SW S. No. Prerequisite software name (click to navigate) License (Free / Procured) Keysight IO Libraries Suite 2018 (version 18.1.23218 or Free later) M9046A PXIe Chassis Drivers Free Xilinx Vivado Design Suite (2017.3 or later)
Page 49
Setting up the M5200x software Follow the on-screen instructions. For PXIe Chassis drivers and firmware When installing the Keysight Chassis Family Driver, PXIe Chassis SFP (Software Front Panel) software is automatically installed. • Chassis firmware version can be checked and updated using PXIe Chassis SFP.
Page 50
Launch the command prompt. b On the root directory, type python and press <Enter>. See Figure The version information of the current Python installation is displayed. Figure 18 Python installation verification on command prompt window M5200A PXIe Digitizer Modules Startup Guide...
Page 51
5b and 6. The procedure for downloading and installing the M5200x software, Module firmware, PathWave FPGA Board Support Package and KS2201A PathWave Test Sync Executive software are described further in this chapter. M5200A PXIe Digitizer Modules Startup Guide...
Setting up the M5200x software Section 3.2: Obtaining License Options Keysight M5200x software does not require any license to be installed. However, the software used with M5200x software require specific license options that you must procure. Visit the respective product page on www.keysight.com...
Setting up the M5200x software Section 3.3: Downloading required software The following list points to the web pages on Keysight website, where you can download the respective software installer files from. Install each software in the sequence shown in Table 10.
“Prerequisite software requirements” on page 48 are installed on the same machine. 3.4.1: Installing Keysight M5200x software After you have downloaded the executable file from Keysight.com, double-click the installer for M5200x Software. Figure 20 Icon for the M5200x software installer...
Page 55
Figure 21 Welcome window on the M5200x Setup Wizard Click Next >. The terms of the License Agreement are displayed. Figure 22 License Agreement window on the M5200x Setup Wizard Select Agree to proceed. M5200A PXIe Digitizer Modules Startup Guide...
Page 56
Information displayed on the M5200x Setup Wizard Click Next >. A progress bar appears indicating the installation status. Figure 24 Progress bar on the M5200x Setup Wizard The completion window on the M5200x Setup Wizard is displayed. M5200A PXIe Digitizer Modules Startup Guide...
Page 57
With the Update FPGA firmware enabled, click Finish to complete the software installation, to exit the M5200x Setup Wizard and to allow the installer to proceed with updating the FPGA firmware revision on the M5200A modules. The following prompt is displayed during FPGA firmware update.
The Keysight M5200x software must be installed to update your module firmware. Downloading the Firmware The latest firmware for the M5200A module is included in the Keysight M5200x software package. Modifying the Firmware To update the FPGA firmware, you may follow the steps defined in the previous section.
3.4.3: Installing KS2201A PathWave Test Sync Executive SW Note that the KS2201A PathWave Test Sync Executive software is not a standalone software. It enhances the Keysight M5200x API to support HVI technology by adding the DLLs required for programming libraries.
KF9000B PathWave FPGA Technical Support page. 3.4.5: Installing M5200A BSP The latest BSP file required to design the M5200A module’s FPGA is included in the Keysight M5200x software package. There is no separate BSP installer for M5200A modules. The M5200A BSP can be accessed only within the PathWave FPGA Design Environment and not separately.
Section 3.5: Launching the software 3.5.1: Launching the M5200x user interface Once you have installed the Keysight M5200x software, you can launch the Soft Front Panel (SFP) from the Start menu. On your Win10 OS, click Start > Keysight M5200x PCIe Module >...
Page 62
As shown in Figure 30, while launching, the Keysight M5200x software auto-detects any active M5200A cards that are connected to the chassis. All such cards are displayed along with the chassis, slot number and VISA address on the Connect to Instrument window.
Page 63
‘Simulation Mode’, as shown in Figure Figure 31 “Simulation Mode” in the status bar on the main window Note that a demo ‘M5200A’ module only is displayed in Figure 29 and in Figure 30 along with other active cards. This entry appears when “Simulation Mode”...
Page 64
This mode is used for active SFP operations. In this mode, toggling the SFP controls changes the signal state on the selected module. The status bar on the main window shows ‘Connected to <VISA-address>’ to indicate the module that has been selected, as shown in Figure M5200A PXIe Digitizer Modules Startup Guide...
Page 65
“Connected to <VISA address>” in the status bar on the main window For more information regarding the features and functionality of the Keysight M5200x SFP, refer to the M5200A PXIe Digitizer Modules User Guide, which can be accessed via the Help menu of the M5200x SFP.
Import required system components and python libraries (as needed). Examples: import sys import os import numpy as np # For keysight_ktm5200x arrays Import the M5200x Python library for programming the M5200A card. Example: import keysight_ktm5200x as m5200x Proceed with creating module objects and defining other M5200x functions.
3.5.3: Initiating PathWave Test Sync Executive software As mentioned earlier, the KS2201A PathWave Test Sync Executive software is not a standalone software. It enhances the Keysight M5200x API to support HVI technology by adding the DLL files required for Python libraries.
SW API to load the k7z file onto the M5200A module’s sandbox. To know about BSP interfaces required to build a custom FPGA logic, refer to the BSP User Guide for the M5200A module, which can be accessed via Help > BSP Help menu options in the KF9000B PathWave FPGA software.
Page 69
Setting up the M5200x software For information about APIs associated with FPGA operations in the M5200A modules, refer to the Python API Help (index.html) located in C:\ Program Files\Keysight\M5200x\python\html. M5200A PXIe Digitizer Modules Startup Guide...
Page 70
Setting up the M5200x software M5200A PXIe Digitizer Modules Startup Guide...
Keysight IO Libraries directly from https://www.keysight.com/find/iolibs. • For Keysight support for help with tools and documentation or to connect with a technical support expert for product and service support, see https://www.keysight.com/find/support. M5200A PXIe Digitizer Modules Startup Guide...
C:\Program Files\Keysight\M5200x\python>pip install keysight_ktm5200x-1.0.43106.tar.gz 4.2.2: Installing Python after the Instrument Driver The installers for M5200A module drivers attempt to install Python during installation. However, there are various reasons, including the ones listed below, that this may not work for you.
SciChart error when launching SFP using LabVIEW example In such cases, you must install the SciChart developer license to launch the SciChart application using a different driver wrapper. Visit https://www.scichart.com/licensing-scichart/ to obtain the required license. M5200A PXIe Digitizer Modules Startup Guide...
Generate Bit File... icon. Figure 36 Error prompted by PathWave FPGA SW if Vivado is not installed In such cases, contact Xilinx support or download Vivado Design Suite from https://www.xilinx.com/. M5200A PXIe Digitizer Modules Startup Guide...
# ExtraNetDelay_low # ExtraNetDelay_high # Explore After changing this option, close the PathWave FPGA interface and relaunch the application for the changes to take effect. Figure 37 Changing place_design -directive in the keysight_common_build.tcl file M5200A PXIe Digitizer Modules Startup Guide...
The safety of any system incorporating the equipment is the responsibility of the assembler of the system. Maintenance To remove dirt or dust from the M5200A module, follow the instructions given in Cleaning the module on page 46 of this document.
Page 78
To avoid electrical shock, do not perform any servicing manually. Return the module to Keysight Service Center. Equipment and accessories For safety reasons, only Keysight approved equipment and accessories WARNING should be used with the module. Position chassis to ensure easy access to remove the modules.
Need help?
Do you have a question about the M5200A and is the answer not in the manual?
Questions and answers