Skip to content

Commit 5a3d718

Browse files
committed
Update readme
1 parent 782d86a commit 5a3d718

File tree

1 file changed

+5
-20
lines changed

1 file changed

+5
-20
lines changed

README.md

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Verilog Ethernet Components Readme
22

3+
[![Build Status](https://github.com/alexforencich/verilog-ethernet/workflows/Regression%20Tests/badge.svg?branch=master)](https://github.com/alexforencich/verilog-ethernet/actions/)
4+
35
For more information and updates: http://alexforencich.com/wiki/en/verilog/ethernet/start
46

57
GitHub repository: https://github.com/alexforencich/verilog-ethernet
@@ -12,8 +14,8 @@ Ethernet frames as well as IP, UDP, and ARP and the components for
1214
constructing a complete UDP/IP stack. Includes MAC modules for gigabit and
1315
10G/25G, a 10G/25G PCS/PMA PHY module, and a 10G/25G combination MAC/PCS/PMA
1416
module. Includes various PTP related components for implementing systems that
15-
require precise time synchronization. Also includes full MyHDL testbench with
16-
intelligent bus cosimulation endpoints.
17+
require precise time synchronization. Also includes full cocotb testbenches
18+
that utilize [cocotbext-eth](https://github.com/alexforencich/cocotbext-eth).
1719

1820
For IP and ARP support only, use ip_complete (1G) or ip_complete_64 (10G/25G).
1921

@@ -569,21 +571,4 @@ bad frame
569571

570572
## Testing
571573

572-
Running the included testbenches requires MyHDL and Icarus Verilog. Make sure
573-
that myhdl.vpi is installed properly for cosimulation to work correctly. The
574-
testbenches can be run with a Python test runner like nose or py.test, or the
575-
individual test scripts can be run with python directly.
576-
577-
### Testbench Files
578-
579-
tb/arp_ep.py : MyHDL ARP frame endpoints
580-
tb/axis_ep.py : MyHDL AXI Stream endpoints
581-
tb/baser_serdes.py : MyHDL 10GBASE-R SERDES endpoints
582-
tb/eth_ep.py : MyHDL Ethernet frame endpoints
583-
tb/gmii_ep.py : MyHDL GMII endpoints
584-
tb/ip_ep.py : MyHDL IP frame endpoints
585-
tb/mii_ep.py : MyHDL MII endpoints
586-
tb/ptp.py : MyHDL PTP clock model
587-
tb/rgmii_ep.py : MyHDL RGMII endpoints
588-
tb/udp_ep.py : MyHDL UDP frame endpoints
589-
tb/xgmii_ep.py : MyHDL XGMII endpoints
574+
Running the included testbenches requires [cocotb](https://github.com/cocotb/cocotb), [cocotbext-axi](https://github.com/alexforencich/cocotbext-axi), [cocotbext-eth](https://github.com/alexforencich/cocotbext-eth), and [Icarus Verilog](http://iverilog.icarus.com/). The testbenches can be run with pytest directly (requires [cocotb-test](https://github.com/themperek/cocotb-test)), pytest via tox, or via cocotb makefiles.

0 commit comments

Comments
 (0)