chipscopy.api.ibert.link¶

chipscopy.api.ibert.create_links(*, rxs, txs)¶

Create link(s) for given RX object(s) and TX object(s). None of the RX or TX object(s) must be part of existing links.

Parameters:

rxs (Union[RX, List[RX]]) – RX object(s) to use for link creation
txs (Union[TX, List[TX]]) – TX object(s) to use for link creation
NOTE: (..) – If passing a list of RX objects and TX objects: must be same for link creation to succeed. For link creation, RX and TX objects are used in the order they appear in the lists.
lists (the length of both the) – must be same for link creation to succeed. For link creation, RX and TX objects are used in the order they appear in the lists.

Return type:

QueryList[Link]

Returns:

Newly created Link object(s)

chipscopy.api.ibert.delete_links(links_to_delete=None)¶

Delete links that were created previously

Parameters:: links_to_delete (Union[Link, List[Link], QueryList[Link], None]) – (Optional) Link objects to delete. .. NOTE::If no link objects are provided, all available links are deleted.

chipscopy.api.ibert.get_all_links()¶

Get all Link object(s)

Return type:: QueryList[Link]
Returns:: List of link(s)

class chipscopy.api.ibert.link.Link(rx, tx, name, handle='', filter_by=<factory>, link_group=None)[source]¶

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

property ber: float¶

Refresh and get the BER value.

Note

There might be some loss of precision when converting the BER value from str to float.

Return type:: float
Returns:: BER str value converted to float

property bit_count¶

Refresh and get the bits received by the RX

Returns:: Bit count

property error_count¶

Refresh and get the error counter value

Returns:: Error counter value

property eye_scan: EyeScan | None¶

Get the EyeScan object attached to the RX that is part of the link.

Return type:: Optional[ForwardRef]
Returns:: Eye scan object if available in RX

filter_by: Dict[str, Any]¶

generate_report()[source]¶: Generate a report for this link and send it to the “printer” for printing

handle: str = ''¶: Handle in the format tx.handle-->rx.handle. If TX/RX in unknown, replace tx/rx.handle with UnknownTX/RX

invalidate()[source]¶

property line_rate: str¶

Refresh and get the line rate of the RX

Return type:: str
Returns:: Line rate

link_group: LinkGroup | None = None¶: Link group this link belongs to

name: str¶: Name of this link

refresh()[source]¶: Refresh the attributes

rx: RX | None¶: RX attached to this link

property status: str¶

Refresh and get the status.

Return type:: str
Returns:: Link status

tx: TX | None¶: TX attached to this link