chipscopy.api.ibert.eye_scan

chipscopy.api.ibert.create_eye_scans(*, target_objs)

Create an instance of EyeScan and attach it to the eye_scan attribute of the target_obj (s)

Parameters

target_objs (Union[RX, Link, List[RX, Link]]) – The object to use for attaching the eye scan instance. The object must be an instance of RX or Link class.

Return type

QueryList[EyeScan]

Returns

List of eye scan object(s) created

chipscopy.api.ibert.delete_eye_scans(scans_to_delete=None)

Delete EyeScan object(s) that were created previously

Parameters

scans_to_delete (Union[EyeScan, List[EyeScan], QueryList[EyeScan], None]) – (Optional) Eye scan object(s) to delete.

Warning

If no eye scan objects are provided, all available eye scans are deleted.

chipscopy.api.ibert.get_all_eye_scans()

Get all EyeScan object(s)

Return type

QueryList[EyeScan]

Returns

List of eye scan object(s)

class chipscopy.api.ibert.eye_scan.ScanPoint(x, y, ber, errors, samples)

x: int

y: int

ber: float

errors: int

samples: int

class chipscopy.api.ibert.eye_scan.Plot2DData(scan_points, ber_floor_value)

scan_points: Dict[Tuple[int, int], chipscopy.api.ibert.eye_scan.ScanPoint]

Collection of ScanPoint instances to represent the 2D eye scan plot

ber_floor_value: float

This value is used as the ber value for any X, Y coordinate whose computed BER was 0

class chipscopy.api.ibert.eye_scan.RawData(ut, prescale, error_count, sample_count, vertical_range, horizontal_range)

Class for storing raw data from the MicroBlaze. The size of all the lists in this class will be the same

ut: List[int]

prescale: List[int]

error_count: List[int]

sample_count: List[int]

vertical_range: List[int]

horizontal_range: List[int]

class chipscopy.api.ibert.eye_scan.ScanData(raw, all_params, processed=None)

Class for storing raw scan data and 2D plot data

raw: chipscopy.api.ibert.eye_scan.RawData

Raw scan data from the MicroBlaze

all_params: dict

All parameters the server used to run the scan in the MicroBlaze

processed: chipscopy.api.ibert.eye_scan.Plot2DData = None

2D plot data. This will only be available if the scan completed successfully

class chipscopy.api.ibert.eye_scan.EyeScan(rx, name, params=<factory>, done_callback=None, progress_callback=None, filter_by=<factory>, status='Not Started', progress=-1.0, stop_time=None, start_time=None, elf_version=None, data_points_read=-1, data_points_expected=-1, scan_data=None, plot=None, _handle_from_cs_server=None, _scan_done_event=<factory>)

Class for interacting with eye scans. Please do not create an instance of this class directly. Please use the factory method create_eye_scans() instead.

rx: chipscopy.api.ibert.rx.RX

RX object attached to this eye scan

name: str

Name of the eye scan

params: Dict[str, chipscopy.api.ibert.eye_scan.params.EyeScanParam]

Dictionary containing the py:class:EyeScanParam instance for every available param

done_callback: Callable[[EyeScan], None] = None

Callback function called when eye scan has ended

progress_callback: Callable[[float], None] = None

Callback function called when eye scan update is received

filter_by: Dict[str, Any]

status: str = 'Not Started'

Status of the eye scan

progress: float = -1.0

Progress of the eye scan in %

stop_time: datetime.datetime = None

Time stamp of when eye scan was stopped in cs_server

start_time: datetime.datetime = None

Time stamp of when eye scan was started in cs_server

elf_version: str = None

ELF version read from the MicroBlaze

data_points_read: int = -1

Number of data points scanned by the MicroBlaze

data_points_expected: int = -1

Total number of data points expected to be scanned by the MicroBlaze

scan_data: chipscopy.api.ibert.eye_scan.ScanData = None

Scan data stored in an instance of the ScanData class

plot: chipscopy.api.ibert.eye_scan.plotter.EyeScanPlot = None

EyeScanPlot instance for interacting with the plot

invalidate()

start(*, show_progress_bar=True)

Send command to cs_server to start the eye scan in the HW.

Parameters

show_progress_bar (bool) – Set to true to show progress bar on stdout

wait_till_done()

Block current thread execution till the eye scan completes OR it is aborted by cs_server/HW.

stop()

Stop eye scan, that is in-progress in the MicroBlaze

generate_report()

Generate a report for this eye scan object and send it to the “printer” for printing