Factory methods

chipscopy.create_session(*, hw_server_url, cs_server_url=None, **kwargs)[source]

Create a new session. Connect to the specified hw_server, and optionally the cs_server.

  • hw_server is used for programming and Versal Memory read/write operations

  • cs_server is used for higher level debug core communication

Example 1: Default session create

my_session = create_session(hw_server_url="TCP:localhost:3121",
                            cs_server_url="TCP:localhost:3042")

Example 2: Disable core scanning and server version checking

my_session = create_session(hw_server_url="TCP:localhost:3121",
                            cs_server_url="TCP:localhost:3042",
                            disable_core_scan=True,
                            bypass_version_check=True)
Parameters

  • hw_server_url (str) – Hardware server URL. Format TCP:<hostname>:<port>

  • cs_server_url (Optional[str]) – ChipScope server URL. Format TCP:<hostname>:<port>

Keyword Arguments

  • disable_core_scan – Set True to completely disable core scanning during discover_and_setup_debug_cores

  • bypass_version_check – Set True to change hw_server and cs_server version mismatch to warning instead of error

  • xvc_mm_server_url – Url for the testing xvc memory map server - For special debug core testing use cases

  • cable_timeout – Seconds before timing out when detecting devices on a jtag cable

  • use_legacy_scanner – Use legacy device scan algorithm

Return type

Session

Returns

New session object.

chipscopy.delete_session(session)[source]

Delete a session. Shuts down any open server connections.

Parameters

session (Session) – The session object to delete

chipscopy.api.session

class chipscopy.api.session.Session(*, hw_server_url, cs_server_url=None, xvc_mm_server_url=None, disable_core_scan, bypass_version_check, cable_timeout, use_legacy_scanner)[source]

Bases: object

Top level object that tracks a connection to a hardware server and optionally, chipscope server. To create and destroy a session, use the factory function create_session() and delete_session().

property cables: chipscopy.api.containers.QueryList[chipscopy.api.cable.Cable]

Returns a list of all cables connected to the hw_server. Similar to vivado get_hw_targets command. target_cables may be jtag or virtual.

Return type

QueryList[Cable]

property devices: chipscopy.api.containers.QueryList[chipscopy.api.device.device.Device]

Returns a list of devices connected to this hw_server and cable. Devices may contain several chains across cables, so don’t always assume a single jtag chain is returned

Parameters

cable (Optional[Cable]) – Get devices for specified cable. None=Scan all cables

Return type

QueryList[Device]

get_param(params)[source]

Generic parameter get and set for low level chipscope server params

Return type

Dict[str, str]

static set_log_level(level=None)[source]

Set the logging level for the ChipScoPy client. This applies to all sessions. Default is “NONE”

Parameters

level (Optional[str]) – The minimum level to use for the logger. Valid levels are “TRACE”, “DEBUG”, “INFO”, “SUCCESS”, “WARNING”, “ERROR”, “CRITICAL”, “NONE”

set_param(params)[source]

Generic parameter get and set for low level chipscope server params