Readback hardware devices
Syntax
readback_hw_device [‑force] [‑capture] [‑readback_file <arg>]
[‑bin_file <arg>] [‑quiet] [‑verbose] [<hw_device>...]
Returns
hardware devices
Usage
Name | Description |
---|---|
[-force]
|
force write of file |
[-capture]
|
capture configuration readback data (ultrascale only) |
[-readback_file]
|
readback file for rbd file output |
[-bin_file]
|
bin file for bin file output |
[-quiet]
|
Ignore command errors |
[-verbose]
|
Suspend message limits during command execution |
[<hw_device>]
|
list of hardware devices Default: current hardware device |
Categories
Description
Read bitstream data from the current hardware device and write it to the specified readback or binary file.
This command returns the name of the readback file created, or returns an error if it fails.
Arguments
-force
- (Optional) Force the overwriting of the specified file if one of the same name already exists.
-capture
- (Optional) Enable readback capture of configuration data on UltraScale devices only. Readback capture can be used to determine the content of user state elements, such as CLB registers, block RAM, distributed RAM, and SRL contents.
-readback_file
<arg> - (Optional) Write a readback file (RDB) which is an ASCII output of the bitstream read from the specified hw_device. This file is similar to the ASCII file that is produced by the write_bitstream -raw_bitfile
command, except that it has no header.
-readback_file
and -bin_file
are optional, one or both of these options must be specified or the command has no output file to write the results to.-bin_file
<arg> - (Optional) Write a binary file (BIN) containing the programming data read back from the specified hw_device. This file is similar to the binary file that is produced by the write_bitstream -bin_file
command.
-quiet
- (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
-verbose
- (Optional) Temporarily override any message limits and return all messages from this command.
set_msg_config
command.<hw_device> - (Optional) The hw_device object to read the programming data from. The hw_device must be specified as an object as returned by the get_hw_devices
or current_hw_device
commands. If the hardware device is not specified, the current_hw_device
will be used.
Example
readback_hw_device -readback_file C:/Data/readback_1.rbd [current_hw_device]