chipscopy.PCIe

class chipscopy.api.pcie.PCIe(*args, **kwds)

refresh()

Reads the PCIe debug memory again, and updated internal properties.

Parameters

None –

Returns

None

read_data()

Reads the PCIe debug memory again, and updated internal properties, same as refresh()

Parameters

None –

Returns

None

reset_core()

Resets the PCIe debug core, telling the IP to start collecting a new state trace

Parameters

None –

Returns

None

get_dot()

Returns a text string of the PCIe LTSSM in the DOT format. DOT is a graph description language: (https://en.wikipedia.org/wiki/DOT_(graph_description_language)) This format can be graphed using python (networkx) or other graphing tools (graphviz and others)

Parameters

None –

Returns

String with the PCIe LTSSM graph in a DOT format, using the same colors and labels as get_plt()

print_trace()

Prints PCIe trace to console, parsing the hierarchy of loops and substates to create a user-friendly output

Parameters

None –

Returns

None

get_plt()

Returns a matplotlib figure to plot, showing the PCIe LTSSM graph. States will be colored green if they have been visited, orange if it’s the last state visited, and grey if not visited. The edge labels represent the number of times that state transition has be traversed.

Parameters

None –

Returns

A matplotlib.pyplot that can be titled and shown later (can use plt.title or plt.show()