Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

info.yaml corrections #306

Merged
merged 3 commits into from
Nov 12, 2023
Merged

info.yaml corrections #306

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76be12e
Update info.yaml
wulfhednar02 Nov 11, 2023
9c3339c
Update info.yaml
wulfhednar02 Nov 12, 2023
5765600
Merge branch 'main' into main
wulfhednar02 Nov 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions projects/tt_um_wokwi_377426511818305537/info.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,43 @@ documentation:
[Tiny Tapeout]: <https://www.tinytapeout.com>
[Wiki]: <https://en.wikipedia.org/wiki/Linear-feedback_shift_register>

# Instructions on how someone could test your project, include things like what buttons do what and how to set the clock if needed
how_to_test: |
1) Clear inputs and reset to ensure known states.
2) Configure the registers using SPI or using the debug_setup pin.
3) Set "output_en" high and observe "prbs_out".
4) Toggle "data_in" to invert "prbs_out" on next rising edge of "data_clk".
5) To restart PRBS after "busy" goes low, clear "output_en" and set "output_en" again.
# A description of what the inputs do (e.g. red button, SPI CLK, SPI MOSI, etc).
inputs:
- spi_cs
- spi_clk
- spi_mosi
- output_en
- data_in
- none
- none
- debug_setup
# A description of what the outputs do (e.g. status LED, SPI MISO, etc)
outputs:
- prbs_out_1
- prbs_out
- prbs_out_n
- prbs_out_n_1
- data_clk
- busy
- debug_out_system_clk
- debug_out_prbs_clk
# A description of what the bidirectional I/O pins do (e.g. I2C SDA, I2C SCL, etc)
bidirectional:
- debug_out_reg_sel_0
- debug_out_reg_sel_1
- debug_out_reg_sel_2
- debug_out_prbs_clk_bypass
- debug_out_data_count_clk
- debug_out_data_count_comb_out
- debug_out_seq_count_comb_out
- none
# The following fields are optional
tag: "prn, prbs, spi, clock divider, registers, " # comma separated list of tags: test, encryption, experiment, clock, animation, utility, industrial, pwm, fpga, alu, microprocessor, risc, riscv, sensor, signal generator, fft, filter, music, bcd, sound, serial, timer, random number generator, calculator, decoder, counter, puzzle, multiplier, game, oscillator,
external_hw: "Connection to SPI port, clock input, and analyzer to observe." # Describe any external hardware needed
Expand Down