Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alexforencich committed May 28, 2019
1 parent 0d8e224 commit b6ebb7d
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,48 @@ cosimulation endpoints.
Template module for peripheral initialization via I2C. For use when one or
more peripheral devices (i.e. PLL chips, jitter attenuators, clock muxes,
etc.) need to be initialized on power-up without the use of a general-purpose
processor.
processor.

### i2c_master module

I2C master module with AXI stream interfaces to control logic.
I2C master module with AXI stream interfaces to control logic.

### i2c_master_axil module

I2C master module with 32-bit AXI lite slave interface.

### i2c_master_wbs_8 module

I2C master module with 8-bit Wishbone slave interface.

### i2c_master_wbs_16 module

I2C master module with 16-bit Wishbone slave interface.

### i2c_slave module

I2C slave module with AXI stream interfaces to control logic.

### i2c_slave_axil_master module

I2C slave module with parametrizable AXI lite master interface.

### i2c_slave_wbm module

I2C slave module with parametrizable Wishbone master interface.


### Source Files

axis_fifo.v : AXI stream FIFO
i2c_init.v : Template I2C bus init state machine module
i2c_master.v : I2C master module
i2c_master_axil.v : I2C master module (32-bit AXI lite slave)
i2c_master_wbs_8.v : I2C master module (8-bit Wishbone slave)
i2c_master_wbs_16.v : I2C master module (16-bit Wishbone slave)
i2c_slave.v : I2C slave module
i2c_slave_axil_master.v : I2C slave module (parametrizable AXI lite master)
i2c_slave_wbm.v : I2C slave module (parametrizable Wishbone master)

## Testing

Expand All @@ -42,6 +68,7 @@ individual test scripts can be run with python directly.

### Testbench Files

tb/axil.py : MyHDL AXI4 lite master and memory BFM
tb/axis_ep.py : MyHDL AXI Stream endpoints
tb/i2c.py : MyHDL I2C master and slave models
tb/wb.py : MyHDL Wishbone master model and RAM model

0 comments on commit b6ebb7d

Please sign in to comment.