Update documentation
diff --git a/.ztr-directory b/.ztr-directory
deleted file mode 100644
index f5acee9..0000000
--- a/.ztr-directory
+++ /dev/null
@@ -1 +0,0 @@
-{"sorting":"name-up","project":null,"icon":null}
\ No newline at end of file
diff --git a/README.md b/README.md
index 265b2f1..42c5874 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
# Particle Detector Frontend
-This is a simple analog frontend for detecting single particles such as cosmic rays, alpha or beta particles. The user can attach a detector, such as a silicon PIN diode to the input. When a particle hits the detector, it will create a current pulse. The current pulse is amplified by the transimpedance amplifier and detected by the comparator. The output of the comparator is made available as an low voltage differential signalling (LVDS) signal at the output and can be further processed by an FPGA, e.g. to count the number of inpinging particles per second.
+This is a simple analog frontend for detecting single particles such as cosmic rays, alpha or beta particles. The user can attach a detector, such as a silicon PIN diode to the input. When a particle hits the detector, it will create a current pulse. The current pulse is amplified by the transimpedance amplifier and detected by the comparator. The output of the comparator is made available as an low voltage differential signaling (LVDS) signal at the output and can be further processed by an FPGA, e.g. to count the number of impinging particles per second.
The ASIC contains the following blocks:
@@ -7,9 +7,9 @@
The blocks are distributed in the layout as follows:
-The overall bandwidth is intended to be approx. 1GHz. The design aims to enable the detection of pulses with a peak current of 5µA and length of 0.5 ns. To understand the functioninng of the circuit, have a look at the schematic xschem/test.sch and run the corresponding ngspice simulation. This simulation tests the circuit using a simple 5µA pulse.
+The overall bandwidth is intended to be approx. 1GHz. The design aims to enable the detection of pulses with a peak current of 5µA and length of 0.5 ns. To understand the functioning of the circuit, have a look at the schematic xschem/test.sch and run the corresponding ngspice simulation. This simulation tests the circuit using a simple 5µA pulse.
-The blocks are inteded to be re-used as IP blocks in future projects. Therefore for each block both schematic as well as a magic layout are available.
+The blocks are intended to be re-used as IP blocks in future projects. Therefore for each block both schematic as well as a magic layout are available.
License:
[](https://opensource.org/licenses/Apache-2.0) [](https://github.com/efabless/caravel_user_project_analog/actions/workflows/user_project_ci.yml) [](https://github.com/efabless/caravel_user_project_analog/actions/workflows/caravan_build.yml)
@@ -19,30 +19,30 @@
The Biasing circuit and TIA have been previously published and were submitted to the MPW-5. The documentation can be found here: [https://github.com/simonwaid/caravel_tia](https://github.com/simonwaid/caravel_tia)
## Active dark current compensation
-The dark current of the detector may lead to saturation of the input TIA. To prevent this, an active dark current compensation circuit was implemente. The circuit is based on [1].
+The dark current of the detector may lead to saturation of the input TIA. To prevent this, an active dark current compensation circuit was implemented. The circuit is based on [1].
-*Schematic:* xschem/tia/feedback_sukwani.sch
-*Layout:* mag/feedback/fb_dark_current.mag
+* Schematic: xschem/tia/feedback_sukwani.sch
+* Layout: mag/feedback/fb_dark_current.mag
-The overall gain with dark current compensation enabled is given in the following. Note that at low frequencies the gain is diminished due to the negative feedback of the dark current compensation.
+The overall gain of the TIA with dark current compensation enabled is given in the following. At low frequencies the gain is diminished due to the negative feedback of the dark current compensation.
## Comparator
-The comparator is composed of saturation tollerant difference amplifiers stages. Each stage has a typical amplification of 10dB. By cascading 6 stages an overall amplification of approx. 60dB is attained. The threshold of the comparator is set by injecting an offset current into the 3rd difference amplifier stage. Prior to the 3rd aplifier stage, AC coupling eliminates the offset introduced by the previous amplifer stages. After the difference amplifer stages, a schmidt trigger is used to convert the differential analog signal to a single ended digital signal. The schmidt trigger contains a difference amplifer with a positive feedback making it bi-stable. The output of this difference amplifer is converted to a digitial signal via current mirrors and 3 cascaded inverter stages.
+The comparator is composed of saturation tolerant difference amplifiers stages. Each stage has a typical amplification of 10dB. By cascading 6 stages an overall amplification of approx. 60dB is attained. The threshold of the comparator is set by injecting an offset current into the 3rd difference amplifier stage. Prior to the 3rd amplifier stage, AC coupling eliminates the offset introduced by the previous amplifier stages. After the difference amplifier stages, a Schmidt trigger is used to convert the differential analog signal to a single ended digital signal. The Schmidt trigger contains a difference amplifier with a positive feedback making it bi-stable. The output of this difference amplifier is converted to a digital signal via current mirrors and 3 cascaded inverter stages.
From a user perspective, the threshold is set via an input current on one of the two input pins. Supplying the current can be attained e.g. via a resistor or a current DAC.
-*Schematic:* xschem/comp/comparator_complete.sch
-*Layout:* mag/comp/comparator.mag
+* Schematic: xschem/comp/comparator_complete.sch
+* Layout: mag/comp/comparator.mag
## LVDS driver
-The implemented LVDS supports termination using resistors from 50 to 100 Ohm. By terminating using 50 Ohm a larger bandwidth can be attained. The following images shows the reaction of the driver to 1ns pulses. Note the different bunches of curves exhibiting a slight time shift. This is due to different process corners. Both the common mode voltage and the differential voltage remain stable over process corners, temperature and device mismatch. The common mode voltage ist set to 3/5 times the operating voltage which results in 1.08V at 1.8V operating voltage. This is slightly below the standard of 1.2V but results in a better performance in terms of speed.
+The implemented LVDS supports termination using resistors from 50 to 100 Ohm. By terminating using 50 Ohm a larger bandwidth can be attained. The following images shows the reaction of the driver to 1ns pulses. Note the different bunches of curves exhibiting a slight time shift. This is due to different process corners. Both the common mode voltage and the differential voltage remain stable over process corners, temperature and device mismatch. The common mode voltage is set to 3/5 times the operating voltage which results in 1.08V at 1.8V operating voltage. This is slightly below the standard of 1.2V but results in a better performance in terms of speed.
-*Schematic:* xschem/lvds/transmitter.sch
-*Layout:* mag/lvds/transmitter.mag
+* Schematic: xschem/lvds/transmitter.sch
+* Layout: mag/lvds/transmitter.mag
## References
[1] [A high speed frontend electronics ASIC for multi-channel single gap RPC detector](https://doi.org/10.1088/1748-0221/16/07/p07042)
\ No newline at end of file
diff --git a/docs/source/blocks.svg b/docs/source/blocks.svg
index 3cc4d24..4d798c1 100644
--- a/docs/source/blocks.svg
+++ b/docs/source/blocks.svg
@@ -9,6 +9,9 @@
id="svg5"
inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)"
sodipodi:docname="blocks.svg"
+ inkscape:export-filename="/home/simon/code/particle_detector/docs/source/blocks.png"
+ inkscape:export-xdpi="150"
+ inkscape:export-ydpi="150"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:xlink="http://www.w3.org/1999/xlink"
@@ -106,7 +109,10 @@
style="font-style:normal;font-weight:normal;font-size:3px;line-height:1.25;font-family:sans-serif;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.264583"
x="59.293003"
y="47.907742"
- id="text3504"><tspan
+ id="text3504"
+ inkscape:export-filename="/home/simon/code/particle_detector/docs/source/blocs.png"
+ inkscape:export-xdpi="300"
+ inkscape:export-ydpi="300"><tspan
sodipodi:role="line"
id="tspan3502"
style="font-size:3px;stroke-width:0.264583"
diff --git a/gds/.ztr-directory b/gds/.ztr-directory
deleted file mode 100644
index f5acee9..0000000
--- a/gds/.ztr-directory
+++ /dev/null
@@ -1 +0,0 @@
-{"sorting":"name-up","project":null,"icon":null}
\ No newline at end of file
