docs: fix typos

designs/eth_ctrl_debug/README.md

@@ -0,0 +1,7 @@
+# Тестовый проект Eth + CTRL
+Проект состоит из AXIS Ethernet и контроллера. Для тестирования сделано три разных частотных домена: ethernet 125MHz, DAC 130MHz, ADC 65MHz для тестирования сихронизации. Есть ILA на все выходы контроллера и на шину AXIS eth -> ctrl. Для отправки пакетов используйте скрипт ```console.py --debug```.
+
+## Сборка
+```make all``` - собрать все до битстрима
+
+```make vivado``` - открыть проект в Vivado

rtl/controller/README.md

@@ -0,0 +1,62 @@
+# Системный контроллер
+
+Контроллер принимает входные пакеты udp с ethernet, передаваемые по axi stream, и выполняет настройку выходных регистров в соотвествии с содержимым этого пакета, а также синхронизирует сигналы между тремя clock domains - есть clk от ethernet, clk для ЦАП и clk для АЦП
+
+## Список параметров:
+- dac_data_width - битность данных ЦАП, <= 16bit
+
+## Список входных портов:
+- eth_clk_in - базовая входная частота
+- dac_clk_in - входная частота ЦАП
+- adc_clk_in - входная частота АЦП
+- rst_n - общий reset 
+- s_axis [8 bit] - AXI stream slave для приема данных от ethernet udp (уже разобранный payload по байтам) - домен eth_clk
+- finish - сигнал окончания приема данных с АЦП, домен adc_clk !
+
+## Список выходных портов:
+- dac_pulse_width[31:0] - выход pulse_width в домене dac_clk
+- dac_pulse_period[31:0] - выход pulse_period в домене dac_clk
+- dac_pulse_height[dac_data_width-1:0] - выход pulse_height в домене dac_clk
+- dac_pulse_num[15:0] - выход pulse_num в домене dac_clk
+---
+- adc_pulse_period[31:0] - выход pulse_period в домене adc_clk
+- adc_pulse_num[15:0] - выход pulse_num в домене adc_clk
+---
+- dac_start - start в домене dac_clk
+- adc_start - start в домене adc_clk
+---
+- dac_rst - rst в домене dac_clk
+- adc_rst - rst в домене adc_clk
+
+## Логика работы:
+по умолчанию после инициализации блок встает в состояние ожидания (*idle*), и становится *ready* для приема данных по axis.
+далее ждет контрольный пакет. всего есть 3 вариации контрольных пакетов (в любом порядке), получаемых по axi stream:
+```
+8'b00001111 - soft reset
+8'b11110000 - start
+8'b10001000 - set_data
+```
+
+*soft reset* отправляет пульс rst на dac_rst и adc_rst, синхронизировав пульсы в их доменах. при этом сброс самого контроллера не происходит, значения остаются как и были
+
+*start* отправляет пульс start на dac_start и adc_start в их доменах. при этом после этого блок перестает быть ready и ждет, пока не придет пульс finish, после этого он возвращается снова в *idle* состояние
+
+*set_data* значит, что следующие 96 бит = 12*8 байт, пришедшии по axis - это конфигурационная информация и ее нужно записать в внутренний регистр на 96 бит.
+
+конфигурационный регистр на 96 бит делится так:
+```
+reg[31:0] - pulse_width
+reg[63:32] - pulse_period
+reg[79:64] - pulse_num
+reg[79+dac_data_width:80] - pulse_height
+```
+
+соотвественно эти записанные значения выставляются на соотвествующие выходные сигналы в доменах dac_clk и adc_clk. выходы обновляются каждый раз, когда происходит set_data, и сигналы сохраняют своё значение до следующего set_data.
+
+## Симуляция
+Тесты запускаются автоматически через make.
+```
+cd tests
+make sim
+```
+Должно выдать "All tests done" в конце симуляции.

scripts/vivado.mk

@@ -177,12 +177,9 @@ gen_ip:
 
 sim: $(PROJECT).xpr gen_ip
 	echo "open_project $(PROJECT).xpr" > run_sim.tcl
-	echo "add_files -fileset sim_1 $(TB_FILES)" >> run_sim.tcl
-	echo "set_property top $(SIM_TOP) [get_filesets sim_1]" >> run_sim.tcl
 	echo "update_compile_order -fileset sources_1" >> run_sim.tcl
 	echo "update_compile_order -fileset sim_1" >> run_sim.tcl
 	echo "launch_simulation" >> run_sim.tcl
-	echo "run all" >> run_sim.tcl
 	vivado -mode batch -source run_sim.tcl
 
 simclean:

software/console.py

@@ -0,0 +1,94 @@
+import argparse
+import socket
+
+
+def run_debug(args, sock):
+    """Debug run: send fixed values to test eth+ctrl on fpga."""
+    print(f"DEBUG MODE: ip={args.ip} send_port={args.send_port}")
+
+    dest = (args.ip, args.send_port)
+
+    # reset
+    sock.sendto(0x0f00.to_bytes(2), dest)
+    print("Sent soft_reset!")
+
+    # config data
+    sock.sendto(format_ctrl_data(0x12345678, 0x9abcdef0,
+                0x0bea, 0xdead, dac_bits=args.dac_bits), dest)
+    print("Config data sent!")
+
+    sock.sendto(0xf000.to_bytes(2), dest)
+    print("Sent start!")
+
+
+def format_ctrl_data(pulse_width: int, pulse_period: int,
+                     pulse_height: int, pulse_num: int, dac_bits: int = 16) -> bytes:
+    """Format data packet for set_data command."""
+    output = bytearray()
+
+    output += 0b10001000.to_bytes(1, 'little')
+
+    # no negative please
+    assert pulse_width > 0, "pulse_width should be positive"
+    assert pulse_period > 0, "pulse_period should be positive"
+    assert pulse_num > 0, "pulse_num should be positive"
+    assert pulse_height > 0, "pulse_height should be positive"
+
+    # overflow check
+    assert pulse_width < 2**32-1, "pulse_width too high"
+    assert pulse_period < 2**32-1, "pulse_period too high"
+    assert pulse_num < 2**16-1, "pulse_num too high"
+    assert pulse_height < 2**dac_bits-1, "pulse_height too high"
+
+    output += pulse_width.to_bytes(4, 'little')
+    output += pulse_period.to_bytes(4, 'little')
+    output += pulse_num.to_bytes(2, 'little')
+    output += pulse_height.to_bytes(2, 'little')
+
+    assert len(output) == 13, "Config data should be 96 bits + 8 bit header"
+    return output
+
+
+def run(args, sock):
+    pass
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="Консоль для рефлектометра"
+    )
+
+    parser.add_argument("--debug", action='store_true',
+                        help="отладочная отправка пакета soft_reset, пакета с данными и пакета start")
+
+    parser.add_argument("--ip", type=str, default="192.168.0.2",
+                        help="IP рефлектометра, по умолчанию 192.168.0.2")
+
+    parser.add_argument("--send-port", type=int, default=8080,
+                        help="Порт для отправки команд")
+
+    parser.add_argument("--recv-port", type=int,
+                        default=8080, help="Порт для приема данных")
+
+    parser.add_argument("--dac-bits", type=int, default=12,
+                        help="Битность ЦАП (влияет на максимальный pulse_height)")
+
+    # передача параметров через аргументы
+    for arg in ("pulse_width", "pulse_period", "pulse_num", "pulse_height"):
+        parser.add_argument(f"--{arg}", type=int,
+                            default=0, help=f"Задать {arg}")
+
+    args = parser.parse_args()
+
+    sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
+
+    if args.debug:
+        run_debug(args, sock)
+    else:
+        run(args, sock)
+
+    sock.close()
+
+
+if __name__ == "__main__":
+    main()