info.yaml

--- 
# TinyTapeout project information
project:
  wokwi_id:    0        # If using wokwi, set this to your project's ID

# If using an HDL, set wokwi_id as 0 and uncomment and list your source files here. 
# Source files must be in ./src and you must list each source file separately
  source_files:        
    - lfsr.v
  top_module:  "greenstyle_lfsr"      # put the name of your top module here, make it unique by prepending your github username

# Keep a track of the submission yaml
yaml_version: 3.0

# As everyone will have access to all designs, try to make it easy for someone new to your design to know what
# it does and how to operate it. This info will be automatically collected and used to make a datasheet for the chip.
#
# Here is a great example: https://github.com/davidsiaw/tt02-davidsiaw-stackcalc/blob/38c5647f83aad2aec675d566aa3d67b98f0aac81/info.yaml
documentation: 
  author:       "Alexander Schönborn"
  title:        "8bit configurable galois lfsr"
  language:     "Verilog"
  description:  "A 8bit configurable galois lfsr."

# Longer description of how the project works. You can use standard markdown format.
  how_it_works: |
      Uses 2 cycles each to set the shift and xor mask registers.
      It has 3 operation modes: normal shift, 

# 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:  |
      After reset, set the shift register and xor state, after that normal shift mode

# A description of what the inputs do
  inputs:               
    - clock
    - reset
    - mode[0] 00 normal shift mode,  01 set register mode, 
    - mode[1] 10 set mode registers, 11 unused
    - data_in[0] is used for both filling register and xor mask state 
    - data_in[1] needs 2 cycles to fill all 8 bits
    - data_in[2] first cyle is lower 4 bits, 2nd upper 4 bits
    - data_in[3] see above
# A description of what the outputs do
  outputs:
    - output[0] lsb normal lfsr output
    - output[1] other 7 bits to see the full state
    - output[2]
    - output[3]
    - output[4]
    - output[5]
    - output[6]
    - output[7]

# The following fields are optional
  tag:          "lfsr, galois"      # 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:  ""      # Describe any external hardware needed
  discord:      "Gr33nStyLe#3847"      # Your discord handle, used for communication and automatically assigning tapeout role after a submission
  doc_link:     ""      # URL to longer form documentation, eg the README.md in your repository
  clock_hz:     1000       # Clock frequency in Hz (if required)
  picture:      ""      # relative path to a picture in your repository