cocotb
latest
Quickstart Guide
Installation
Tutorials
Tutorial: Endian Swapper
Tutorial: Driver Cosimulation
More Examples
How-to Guides
Writing Testbenches
Coroutines
Triggers
Testbench Tools
Rotating Log Files
Key topics
Installing the Development Version
Troubleshooting
Reference
Build options and Environment Variables
Python Code Library Reference
GPI Library Reference
Simulator Support
Writing cocotb extensions
Development & Community
Roadmap
Contributors
Release Notes
Further Resources
Index
Classes, Methods, Variables etc.
Python Modules
Glossary
cocotb
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
_
_def_file (cocotb.handle.SimHandleBase attribute)
_def_name (cocotb.handle.SimHandleBase attribute)
_driver_send() (cocotb.drivers.BusDriver method)
(cocotb.drivers.Driver method)
_id() (cocotb.handle.HierarchyObject method)
_monitor_recv() (cocotb.monitors.Monitor method)
_name (cocotb.handle.SimHandleBase attribute)
_next_valids() (cocotb.drivers.ValidatedBusDriver method)
_path (cocotb.handle.SimHandleBase attribute)
_recv() (cocotb.monitors.Monitor method)
_send() (cocotb.drivers.Driver method)
_type (cocotb.handle.SimHandleBase attribute)
_wait() (cocotb.triggers.Waitable method)
_wait_for_nsignal() (cocotb.drivers.BusDriver method)
_wait_for_signal() (cocotb.drivers.BusDriver method)
A
acquire() (cocotb.triggers.Lock method)
add() (cocotb.scheduler.Scheduler method)
add_callback() (cocotb.monitors.Monitor method)
add_interface() (cocotb.scoreboard.Scoreboard method)
add_option() (cocotb.regression.TestFactory method)
add_test() (cocotb.scheduler.Scheduler method)
append() (cocotb.drivers.Driver method)
argv (in module cocotb)
assign() (cocotb.binary.BinaryValue method)
AvalonMaster (class in cocotb.drivers.avalon)
AvalonMemory (class in cocotb.drivers.avalon)
AvalonMM (class in cocotb.drivers.avalon)
AvalonST (class in cocotb.drivers.avalon)
(class in cocotb.monitors.avalon)
AvalonSTPkts (class in cocotb.drivers.avalon)
(class in cocotb.monitors.avalon)
AXI4LiteMaster (class in cocotb.drivers.amba)
AXI4Master (class in cocotb.drivers.amba)
AXI4Slave (class in cocotb.drivers.amba)
B
BFM
BinaryRepresentation (class in cocotb.binary)
BinaryValue (class in cocotb.binary)
binstr() (cocotb.binary.BinaryValue property)
BitDriver (class in cocotb.drivers)
buff() (cocotb.binary.BinaryValue property)
Bus (class in cocotb.bus)
BusDriver (class in cocotb.drivers)
BusMonitor (class in cocotb.monitors)
C
capture() (cocotb.bus.Bus method)
cleanup() (cocotb.scheduler.Scheduler method)
clear() (cocotb.drivers.Driver method)
(cocotb.triggers.Event method)
(cocotb.wavedrom.Wavedrom method)
Clock (class in cocotb.clock)
ClockCycles (class in cocotb.triggers)
cocotb.generators
module
cocotb.generators.bit
module
cocotb.generators.byte
module
cocotb.handle
module
cocotb.ipython_support
module
cocotb.result
module
cocotb.scoreboard
module
cocotb.simulator
module
cocotb.utils
module
cocotb.wavedrom
module
COCOTB_ANSI_OUTPUT
COCOTB_ATTACH
,
[1]
COCOTB_HDL_TIMEPRECISION
Make Variable
COCOTB_HDL_TIMEUNIT
Make Variable
COCOTB_HOOKS
,
[1]
COCOTB_LOG_LEVEL
,
[1]
COCOTB_PDB_ON_EXCEPTION
COCOTB_RESOLVE_X
COCOTB_RESULTS_FILE
,
[1]
Combine (class in cocotb.triggers)
combine() (in module cocotb.generators)
compare() (cocotb.scoreboard.Scoreboard method)
COMPILE_ARGS
Make Variable
ConstantObject (class in cocotb.handle)
coroutine
(class in cocotb)
coroutine function
create_error() (in module cocotb.result)
create_task() (cocotb.scheduler.Scheduler static method)
created_sim_time (logging.LogRecord attribute)
CUSTOM_COMPILE_DEPS
Make Variable
CUSTOM_SIM_DEPS
Make Variable
D
default_config() (in module cocotb.log)
Deposit (class in cocotb.handle)
deregister() (cocotb.simulator.gpi_cb_hdl method)
drive() (cocotb.bus.Bus method)
Driver (class in cocotb.drivers)
drivers() (cocotb.handle.NonConstantObject method)
DUT
DUV
E
Edge (class in cocotb.triggers)
embed() (in module cocotb.ipython_support)
EnumObject (class in cocotb.handle)
environment variable
COCOTB_ANSI_OUTPUT
,
[1]
COCOTB_ATTACH
,
[1]
,
[2]
COCOTB_ENABLE_PROFILING
COCOTB_HOOKS
,
[1]
,
[2]
COCOTB_LIBRARY_COVERAGE
COCOTB_LOG_LEVEL
,
[1]
,
[2]
COCOTB_PDB_ON_EXCEPTION
,
[1]
COCOTB_PY_DIR
COCOTB_REDUCED_LOG_FMT
COCOTB_RESOLVE_X
,
[1]
COCOTB_RESULTS_FILE
,
[1]
,
[2]
COCOTB_SCHEDULER_DEBUG
COCOTB_SHARE_DIR
COVERAGE
GPI_EXTRA
,
[1]
LIBPYTHON_LOC
LICENSE_QUEUE
MEMCHECK
MODULE
,
[1]
,
[2]
,
[3]
NO_COLOR
,
[1]
,
[2]
PLUSARGS
RANDOM_SEED
,
[1]
,
[2]
SCRIPT_FILE
TESTCASE
,
[1]
,
[2]
,
[3]
TOPLEVEL
,
[1]
,
[2]
,
[3]
Event (class in cocotb.triggers)
external (class in cocotb)
ExternalException
EXTRA_ARGS
Make Variable
extract_coro_stack() (in module cocotb.utils)
F
FallingEdge (class in cocotb.triggers)
finish_scheduler() (cocotb.scheduler.Scheduler method)
finish_test() (cocotb.scheduler.Scheduler method)
First (class in cocotb.triggers)
FLI
Force (class in cocotb.handle)
fork() (in module cocotb)
Freeze (class in cocotb.handle)
from_discovery() (cocotb.regression.RegressionManager class method)
function (class in cocotb)
G
gaussian() (in module cocotb.generators)
generate_tests() (cocotb.regression.TestFactory method)
get() (cocotb.wavedrom.Wavedrom method)
get_bytes() (in module cocotb.generators.byte)
get_const() (cocotb.simulator.gpi_sim_hdl method)
get_definition_file() (cocotb.simulator.gpi_sim_hdl method)
get_definition_name() (cocotb.simulator.gpi_sim_hdl method)
get_handle_by_index() (cocotb.simulator.gpi_sim_hdl method)
get_handle_by_name() (cocotb.simulator.gpi_sim_hdl method)
get_name_string() (cocotb.simulator.gpi_sim_hdl method)
get_num_elems() (cocotb.simulator.gpi_sim_hdl method)
get_precision() (in module cocotb.simulator)
get_range() (cocotb.simulator.gpi_sim_hdl method)
get_root_handle() (in module cocotb.simulator)
get_signal_val_binstr() (cocotb.simulator.gpi_sim_hdl method)
get_signal_val_long() (cocotb.simulator.gpi_sim_hdl method)
get_signal_val_real() (cocotb.simulator.gpi_sim_hdl method)
get_signal_val_str() (cocotb.simulator.gpi_sim_hdl method)
get_sim_steps() (in module cocotb.utils)
get_sim_time() (in module cocotb.simulator)
(in module cocotb.utils)
get_simulator_product() (in module cocotb.simulator)
get_simulator_version() (in module cocotb.simulator)
get_time_from_sim_steps() (in module cocotb.utils)
get_type() (cocotb.simulator.gpi_sim_hdl method)
get_type_string() (cocotb.simulator.gpi_sim_hdl method)
GPI
gpi_cb_hdl (C++ type)
(class in cocotb.simulator)
gpi_cleanup (C++ function)
gpi_deregister_callback (C++ function)
gpi_edge (C++ enum)
gpi_edge::GPI_FALLING (C++ enumerator)
gpi_edge::GPI_RISING (C++ enumerator)
gpi_edge_e (C++ type)
gpi_event_e (C++ enum)
gpi_event_e::SIM_FAIL (C++ enumerator)
gpi_event_e::SIM_INFO (C++ enumerator)
gpi_event_e::SIM_TEST_FAIL (C++ enumerator)
gpi_event_t (C++ type)
GPI_EXPORT (C macro)
GPI_EXTRA
gpi_free_handle (C++ function)
gpi_get_callback_data (C++ function)
gpi_get_definition_file (C++ function)
gpi_get_definition_name (C++ function)
gpi_get_handle_by_index (C++ function)
gpi_get_handle_by_name (C++ function)
gpi_get_num_elems (C++ function)
gpi_get_object_type (C++ function)
gpi_get_range_left (C++ function)
gpi_get_range_right (C++ function)
gpi_get_root_handle (C++ function)
gpi_get_signal_name_str (C++ function)
gpi_get_signal_type_str (C++ function)
gpi_get_signal_value_binstr (C++ function)
gpi_get_signal_value_long (C++ function)
gpi_get_signal_value_real (C++ function)
gpi_get_signal_value_str (C++ function)
gpi_get_sim_precision (C++ function)
gpi_get_sim_time (C++ function)
gpi_get_simulator_product (C++ function)
gpi_get_simulator_version (C++ function)
gpi_has_registered_impl (C++ function)
gpi_is_constant (C++ function)
gpi_is_indexable (C++ function)
gpi_iterate (C++ function)
gpi_iterator_hdl (C++ type)
(class in cocotb.simulator)
gpi_iterator_sel_e (C++ enum)
gpi_iterator_sel_e::GPI_DRIVERS (C++ enumerator)
gpi_iterator_sel_e::GPI_LOADS (C++ enumerator)
gpi_iterator_sel_e::GPI_OBJECTS (C++ enumerator)
gpi_iterator_sel_t (C++ type)
gpi_next (C++ function)
gpi_objtype_e (C++ enum)
gpi_objtype_e::GPI_ARRAY (C++ enumerator)
gpi_objtype_e::GPI_ENUM (C++ enumerator)
gpi_objtype_e::GPI_GENARRAY (C++ enumerator)
gpi_objtype_e::GPI_INTEGER (C++ enumerator)
gpi_objtype_e::GPI_MEMORY (C++ enumerator)
gpi_objtype_e::GPI_MODULE (C++ enumerator)
gpi_objtype_e::GPI_NET (C++ enumerator)
gpi_objtype_e::GPI_REAL (C++ enumerator)
gpi_objtype_e::GPI_REGISTER (C++ enumerator)
gpi_objtype_e::GPI_STRING (C++ enumerator)
gpi_objtype_e::GPI_STRUCTURE (C++ enumerator)
gpi_objtype_e::GPI_UNKNOWN (C++ enumerator)
gpi_objtype_t (C++ type)
gpi_print_registered_impl (C++ function)
gpi_register_nexttime_callback (C++ function)
gpi_register_readonly_callback (C++ function)
gpi_register_readwrite_callback (C++ function)
gpi_register_timed_callback (C++ function)
gpi_register_value_change_callback (C++ function)
gpi_set_action_e (C++ enum)
gpi_set_action_e::GPI_DEPOSIT (C++ enumerator)
gpi_set_action_e::GPI_FORCE (C++ enumerator)
gpi_set_action_e::GPI_RELEASE (C++ enumerator)
gpi_set_action_t (C++ type)
gpi_set_signal_value_binstr (C++ function)
gpi_set_signal_value_int (C++ function)
gpi_set_signal_value_real (C++ function)
gpi_set_signal_value_str (C++ function)
gpi_sim_end (C++ function)
gpi_sim_hdl (C++ type)
(class in cocotb.simulator)
GPITrigger (class in cocotb.triggers)
GUI
Make Variable
H
HAL
handle_result() (cocotb.regression.RegressionManager method)
HDL
hexdiffs() (in module cocotb.utils)
hexdump() (in module cocotb.utils)
HierarchyArrayObject (class in cocotb.handle)
HierarchyObject (class in cocotb.handle)
hook (class in cocotb)
I
idle() (cocotb.drivers.xgmii.XGMII method)
in_reset() (cocotb.monitors.BusMonitor property)
incrementing_data() (in module cocotb.generators.byte)
integer() (cocotb.binary.BinaryValue property)
IntegerObject (class in cocotb.handle)
intermittent_single_cycles() (in module cocotb.generators.bit)
is_resolvable() (cocotb.binary.BinaryValue property)
is_running() (in module cocotb.simulator)
is_set() (cocotb.triggers.Event method)
iterate() (cocotb.simulator.gpi_sim_hdl method)
J
Join (class in cocotb.triggers)
join() (in module cocotb.decorators.RunningTask)
K
kill() (cocotb.drivers.Driver method)
(cocotb.monitors.Monitor method)
(in module cocotb.decorators.RunningTask)
L
LANGUAGE (in module cocotb)
layer1() (cocotb.drivers.xgmii.XGMII static method)
lazy_property (class in cocotb.utils)
LICENSE_QUEUE
loads() (cocotb.handle.NonConstantObject method)
Lock (class in cocotb.triggers)
locked (cocotb.triggers.Lock attribute)
log_level() (in module cocotb.simulator)
log_msg() (in module cocotb.simulator)
M
Make Variable
COCOTB_HDL_TIMEPRECISION
COCOTB_HDL_TIMEUNIT
COMPILE_ARGS
CUSTOM_COMPILE_DEPS
CUSTOM_SIM_DEPS
EXTRA_ARGS
GUI
PLUSARGS
RUN_ARGS
SIM
SIM_ARGS
SIM_BUILD
TOPLEVEL_LANG
VERILOG_SOURCES
VHDL_SOURCES
VHDL_SOURCES_<lib>
WAVES
MDV
ModifiableObject (class in cocotb.handle)
MODULE
,
[1]
,
[2]
module
cocotb.generators
cocotb.generators.bit
cocotb.generators.byte
cocotb.handle
cocotb.ipython_support
cocotb.result
cocotb.scoreboard
cocotb.simulator
cocotb.utils
cocotb.wavedrom
Monitor (class in cocotb.monitors)
N
n_bits() (cocotb.binary.BinaryValue property)
next_test() (cocotb.regression.RegressionManager method)
NextTimeStep (class in cocotb.triggers)
NO_COLOR
,
[1]
NonConstantObject (class in cocotb.handle)
NonHierarchyIndexableObject (class in cocotb.handle)
NonHierarchyObject (class in cocotb.handle)
O
OPBMaster (class in cocotb.drivers.opb)
P
pack() (in module cocotb.utils)
ParametrizedSingleton (class in cocotb.utils)
PLUSARGS
Make Variable
plusargs (in module cocotb)
prime() (cocotb.triggers.Trigger method)
Python Enhancement Proposals
PEP 420
PEP 517
,
[1]
PEP 525
Q
queue() (cocotb.scheduler.Scheduler method)
queue_function() (cocotb.scheduler.Scheduler method)
R
raise_error() (in module cocotb.result)
random_50_percent() (in module cocotb.generators.bit)
random_data() (in module cocotb.generators.byte)
RANDOM_SEED
,
[1]
(in module cocotb)
react() (cocotb.scheduler.Scheduler method)
read() (cocotb.drivers.amba.AXI4LiteMaster method)
(cocotb.drivers.amba.AXI4Master method)
(cocotb.drivers.avalon.AvalonMaster method)
(cocotb.drivers.opb.OPBMaster method)
ReadOnly (class in cocotb.triggers)
ReadWrite (class in cocotb.triggers)
RealObject (class in cocotb.handle)
RegionObject (class in cocotb.handle)
register_nextstep_callback() (in module cocotb.simulator)
register_readonly_callback() (in module cocotb.simulator)
register_rwsynch_callback() (in module cocotb.simulator)
register_timed_callback() (in module cocotb.simulator)
register_value_change_callback() (in module cocotb.simulator)
regression_manager (in module cocotb)
RegressionManager (class in cocotb.regression)
reject_remaining_kwargs() (in module cocotb.utils)
Release (class in cocotb.handle)
release() (cocotb.triggers.Lock method)
remove_traceback_frames() (in module cocotb.utils)
repeat() (in module cocotb.generators)
repeating_bytes() (in module cocotb.generators.byte)
result() (cocotb.scoreboard.Scoreboard property)
ReturnValue
retval() (cocotb.triggers.Join property)
RisingEdge (class in cocotb.triggers)
RTL
RUN_ARGS
Make Variable
run_in_executor() (cocotb.scheduler.Scheduler method)
run_ipython() (in module cocotb.ipython_support)
S
sample() (cocotb.bus.Bus method)
(cocotb.wavedrom.Wavedrom method)
schedule() (cocotb.scheduler.Scheduler method)
Scheduler (class in cocotb.scheduler)
scheduler (in module cocotb)
Scoreboard (class in cocotb.scoreboard)
send() (cocotb.drivers.Driver method)
set() (cocotb.triggers.Event method)
set_signal_val_binstr() (cocotb.simulator.gpi_sim_hdl method)
set_signal_val_int() (cocotb.simulator.gpi_sim_hdl method)
set_signal_val_real() (cocotb.simulator.gpi_sim_hdl method)
set_signal_val_str() (cocotb.simulator.gpi_sim_hdl method)
set_valid_generator() (cocotb.drivers.ValidatedBusDriver method)
setimmediatevalue() (cocotb.handle.NonHierarchyObject method)
signed_integer() (cocotb.binary.BinaryValue property)
SIGNED_MAGNITUDE (cocotb.binary.BinaryRepresentation attribute)
SIM
Make Variable
SIM_ARGS
Make Variable
SIM_BUILD
Make Variable
SIM_NAME (in module cocotb)
SIM_VERSION (in module cocotb)
SimColourLogFormatter (class in cocotb.log)
SimFailure
SimHandle() (in module cocotb.handle)
SimHandleBase (class in cocotb.handle)
SimLogFormatter (class in cocotb.log)
SimTimeContextFilter (class in cocotb.log)
SimTimeoutError
sine_wave() (in module cocotb.generators)
start() (cocotb.clock.Clock method)
(cocotb.drivers.BitDriver method)
start_soon() (cocotb.scheduler.Scheduler method)
stop() (cocotb.drivers.BitDriver method)
stop_simulator() (in module cocotb.simulator)
StringObject (class in cocotb.handle)
T
task
terminate() (cocotb.drivers.xgmii.XGMII method)
test (class in cocotb)
TESTCASE
,
[1]
,
[2]
TestComplete
TestError
TestFactory (class in cocotb.regression)
TestFailure
TestSuccess
Timer (class in cocotb.triggers)
top (in module cocotb)
TOPLEVEL
,
[1]
,
[2]
TOPLEVEL_LANG
Make Variable
trace (class in cocotb.wavedrom)
Trigger (class in cocotb.triggers)
TWOS_COMPLEMENT (cocotb.binary.BinaryRepresentation attribute)
U
unpack() (in module cocotb.utils)
unprime() (cocotb.triggers.GPITrigger method)
(cocotb.triggers.Trigger method)
unschedule() (cocotb.scheduler.Scheduler method)
UNSIGNED (cocotb.binary.BinaryRepresentation attribute)
UVM
V
ValidatedBusDriver (class in cocotb.drivers)
value() (cocotb.binary.BinaryValue property)
(cocotb.handle.ConstantObject property)
(cocotb.handle.EnumObject property)
(cocotb.handle.IntegerObject property)
(cocotb.handle.ModifiableObject property)
(cocotb.handle.NonHierarchyIndexableObject property)
(cocotb.handle.NonHierarchyObject property)
(cocotb.handle.RealObject property)
(cocotb.handle.StringObject property)
VERILOG_SOURCES
Make Variable
VHDL_SOURCES
Make Variable
VHDL_SOURCES_<lib>
Make Variable
VHPI
VIP
VPI
W
wait() (cocotb.triggers.Event method)
wait_for_recv() (cocotb.monitors.Monitor method)
Waitable (class in cocotb.triggers)
walk_coro_stack() (in module cocotb.utils)
want_color_output() (in module cocotb.utils)
wave() (in module cocotb.generators.bit)
Wavedrom (class in cocotb.wavedrom)
WAVES
Make Variable
with_timeout() (in module cocotb.triggers)
write() (cocotb.drivers.amba.AXI4LiteMaster method)
(cocotb.drivers.amba.AXI4Master method)
(cocotb.drivers.avalon.AvalonMaster method)
(cocotb.drivers.opb.OPBMaster method)
X
XGMII (class in cocotb.drivers.xgmii)
(class in cocotb.monitors.xgmii)
Read the Docs
v: latest
Versions
latest
stable
v1.4.0
v1.3.1
v1.3.0
v1.2.0
v1.1
Downloads
On Read the Docs
Project Home
Builds