Added documentation and updated README

README.md

@@ -4,11 +4,15 @@
 
 This project is based on the RFSoC SoC Blockset reference design, adapted as a prototype for a Radar Electronic Support Measures (R-ESM) receiver.
 
-### Current Status
+The system implements a high-throughput signal chain in the FPGA (PL) and performs frame-based processing in the processor (PS).
 
-- Tx subsystem: simple tone generator (to be replaced by LFM pulse generator)
+---
+
+## Current Status
+
+- Tx subsystem: LFM pulse generator (DDS-based, complex output)
 - Rx subsystem: fully functional channelizer pipeline (PFB-based)
-- PL → PS interface: AXI4-Stream + DMA working
+- PL → PS interface: AXI4-Stream + DMA operational
 - PS processing: frame-based algorithm (RMS + peak detection)
 
 ---
@@ -21,7 +25,7 @@ ADC → Channelizer (PFB, 512 bins)
 → AXI4-Stream (uint64)  
 → DMA (S2MM)  
 → PS Memory  
-→ Processor Algorithm (frame-based)
+→ Processor Algorithm  
 
 ---
 
@@ -37,48 +41,26 @@ ADC → Channelizer (PFB, 512 bins)
 
 ---
 
-## DMA (PL → PS)
+## 📚 Documentation
 
-- Data type: uint64
+### FPGA (PL)
-- Frame size: 512
-- Buffers: 16
-- Memory: PS DDR
 
-Each TLAST corresponds to one DMA frame.
+- [Tx Subsystem (Pulse Generator)](docs/pl_tx_subsystem.md)
+- [Rx Subsystem (Channelizer)](docs/pl_rx_subsystem.md)
+
+### Processor (PS)
+
+- [PS Subsystem](docs/ps_subsystem.md)
 
 ---
 
-## Processor (PS)
+## System Flow
 
-- Event-driven execution (triggered by DMA)
+Tx → Rx → PS
-- No task queueing
-- Frames may be dropped if processing is slower than input rate
 
----
+- Tx generates waveform  
-
+- Rx captures and channelizes  
-## Data Path in PS
+- PS processes frames  
-
-- Stream Read → uint64[512]
-- Bit extraction → real/imag
-- Conversion → complex vector
-- Processing → RMS + peak detection
-
----
-
-## Performance Notes
-
-- Bottleneck: unpacking + type conversion
-- PS cannot keep up with full-rate stream
-- Frames are skipped under load
-
----
-
-## FrFT Integration Plan
-
-- Replace Processor Algorithm with FrFT
-- Keep all other components unchanged
-- Input: complex single [512x1]
-- Accept dropped frames initially
 
 ---
 

docs/pl_rx_subsystem.md

@@ -0,0 +1,34 @@
+# 📡 PL Rx Subsystem (Channelizer)
+
+## Overview
+
+Implements PFB channelizer and FFT processing.
+
+---
+
+## Architecture
+
+ADC → PFB → FFT → Capture → FIFO → AXI → DMA
+
+---
+
+## Processing
+
+- 4096 MSPS input
+- Decimation 8
+- FFT 512 bins
+
+---
+
+## Output
+
+- AXI4-Stream
+- uint64 format
+- TLAST per frame
+
+---
+
+## 🔗 Related Components
+
+- [PL Tx Subsystem](pl_tx_subsystem.md)
+- [PS Subsystem](ps_subsystem.md)

docs/pl_tx_subsystem.md

@@ -0,0 +1,49 @@
+# 📡 PL Tx Subsystem (Pulse Generator)
+
+## Overview
+
+The Tx subsystem implements a pulse-based LFM chirp generator using a DDS/NCO architecture.
+
+---
+
+## Architecture
+
+TxPulseStart → pulse_gen_ctrl → tx_active → NCO → Output
+
+---
+
+## Chirp Generation
+
+Δφ[n] = Δφ[n−1] + step  
+φ[n]  = φ[n−1] + Δφ[n]
+
+---
+
+## Parameterization
+
+- Fc (center frequency)
+- B (bandwidth)
+
+Derived:
+f_start = Fc − B/2  
+step    = B / (N − 1)
+
+---
+
+## Pulse Timing
+
+|<------ PRI ------>|
+|<-- pulse -->| idle |
+
+---
+
+## Trigger
+
+Controlled via TxPulseStart (from PS subsystem)
+
+---
+
+## 🔗 Related Components
+
+- [PS Subsystem](ps_subsystem.md)
+- [PL Rx Subsystem](pl_rx_subsystem.md)

docs/ps_subsystem.md

@@ -0,0 +1,32 @@
+# 🧠 PS Subsystem
+
+## Overview
+
+Handles control and processing.
+
+---
+
+## Control
+
+- Writes parameters
+- Triggers Tx (TxPulseStart)
+
+---
+
+## Processing
+
+DMA → unpack → complex → RMS/peak
+
+---
+
+## Execution
+
+- Event-driven
+- Frame drops possible
+
+---
+
+## 🔗 Related Components
+
+- [PL Tx Subsystem](pl_tx_subsystem.md)
+- [PL Rx Subsystem](pl_rx_subsystem.md)

resources/project/qaw0eS1zuuY1ar9TdPn1GMfrjbQ/rW25SbP5jRWeIzL7_iMpZrrygYkd.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info/>

resources/project/qaw0eS1zuuY1ar9TdPn1GMfrjbQ/rW25SbP5jRWeIzL7_iMpZrrygYkp.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info location="docs" type="File"/>

resources/project/rW25SbP5jRWeIzL7_iMpZrrygYk/8i67CMLFhpgTFLAi_RBlc2P1lI0d.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info/>

resources/project/rW25SbP5jRWeIzL7_iMpZrrygYk/8i67CMLFhpgTFLAi_RBlc2P1lI0p.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info location="ps_subsystem.md" type="File"/>

resources/project/rW25SbP5jRWeIzL7_iMpZrrygYk/XVu9f1ZjVk2AJ99l5f9CAU_dcMEd.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info/>

resources/project/rW25SbP5jRWeIzL7_iMpZrrygYk/XVu9f1ZjVk2AJ99l5f9CAU_dcMEp.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info location="pl_rx_subsystem.md" type="File"/>

resources/project/rW25SbP5jRWeIzL7_iMpZrrygYk/mT-GHnZui1JHuHyjd1ddvO5o-Tsd.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info/>

resources/project/rW25SbP5jRWeIzL7_iMpZrrygYk/mT-GHnZui1JHuHyjd1ddvO5o-Tsp.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info location="1" type="DIR_SIGNIFIER"/>

resources/project/rW25SbP5jRWeIzL7_iMpZrrygYk/uS1pkYbM9dJDnKGtwfzZHrJKyTYd.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info/>

resources/project/rW25SbP5jRWeIzL7_iMpZrrygYk/uS1pkYbM9dJDnKGtwfzZHrJKyTYp.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info location="pl_tx_subsystem.md" type="File"/>