updated documentation
diff --git a/README.md b/README.md
index d59aa35..b1e549e 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,26 @@
This is the Google/EFabless/Skywater Caravel submission of the Amateur Radio Satellite Transceiver.
-This submission includes a bandgap design with independant CTAT and PTATs available.
+## Design
+
+These blocks serve as the first pieces in a larger design of an open source amateur radio satellite transceiver - this is the first tapeout submission.
+
+The design sources of the continued project can be found here: [amsat_txrx_ic](https://github.com/yrrapt/amsat_txrx_ic).
+
+### 1.3 - 3.6 GHz Fractional-N Phase Locked Loop
+
+
+
+A S-Band phase locked loop employing a differential ring oscillator VCO with quadrature outputs. CML (Current Mode Logic) and flip-flop based pre-scaler dividers are used with a fractional-N divider which uses a 3rd order MASH structure with dithering. Finally a PFD (Phase Frequency Detector) is combined with a charge pump with off chip filtering to complete the loop.
+
+A cell based buffer is used to drive the external 100 ohm differential output.
+
+### Bandgap
+
+
+
+A bandgap reference with separate PTAT and CTAT currents. Provides less than variation from -40 to 125 degrees celcius. 6 bits of trimming on both PTAT and CTAT allows less than 1% accuracy over process variations.
+
## Using the sources
diff --git a/doc/bandgap_trimmed/bandgap_trimmed.png b/doc/bandgap_trimmed/bandgap_trimmed.png
new file mode 100644
index 0000000..75e62a0
--- /dev/null
+++ b/doc/bandgap_trimmed/bandgap_trimmed.png
Binary files differ
diff --git a/doc/chargepump/chargepump_cell.png b/doc/chargepump/chargepump_cell.png
new file mode 100644
index 0000000..b729aa0
--- /dev/null
+++ b/doc/chargepump/chargepump_cell.png
Binary files differ
diff --git a/doc/chargepump/chargepump_set.png b/doc/chargepump/chargepump_set.png
new file mode 100644
index 0000000..61ed711
--- /dev/null
+++ b/doc/chargepump/chargepump_set.png
Binary files differ
diff --git a/doc/divider_cml/divider_cml.png b/doc/divider_cml/divider_cml.png
new file mode 100644
index 0000000..0fbbf04
--- /dev/null
+++ b/doc/divider_cml/divider_cml.png
Binary files differ
diff --git a/doc/divider_ff/divider_ff.png b/doc/divider_ff/divider_ff.png
new file mode 100644
index 0000000..3fd35bb
--- /dev/null
+++ b/doc/divider_ff/divider_ff.png
Binary files differ
diff --git a/doc/fractional_n_divider/fractional_n_divider.png b/doc/fractional_n_divider/fractional_n_divider.png
new file mode 100644
index 0000000..6df2a8b
--- /dev/null
+++ b/doc/fractional_n_divider/fractional_n_divider.png
Binary files differ
diff --git a/doc/images/caravel.Screen Shot 2020-10-29 at 11.03.24 AM.png b/doc/images/caravel.Screen Shot 2020-10-29 at 11.03.24 AM.png
deleted file mode 100644
index f95afc4..0000000
--- a/doc/images/caravel.Screen Shot 2020-10-29 at 11.03.24 AM.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/caravel.Screen Shot 2020-11-04 at 7.36.31 PM.png b/doc/images/caravel.Screen Shot 2020-11-04 at 7.36.31 PM.png
deleted file mode 100644
index 57b6ac6..0000000
--- a/doc/images/caravel.Screen Shot 2020-11-04 at 7.36.31 PM.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/caravel.Screen Shot 2020-11-04 at 7.36.35 PM.png b/doc/images/caravel.Screen Shot 2020-11-04 at 7.36.35 PM.png
deleted file mode 100644
index 4bc96f7..0000000
--- a/doc/images/caravel.Screen Shot 2020-11-04 at 7.36.35 PM.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/caravel.Screen Shot 2020-11-04 at 7.37.31 PM.png b/doc/images/caravel.Screen Shot 2020-11-04 at 7.37.31 PM.png
deleted file mode 100644
index 3872504..0000000
--- a/doc/images/caravel.Screen Shot 2020-11-04 at 7.37.31 PM.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/caravel.Screen Shot 2020-11-04 at 7.37.35 PM.png b/doc/images/caravel.Screen Shot 2020-11-04 at 7.37.35 PM.png
deleted file mode 100644
index 24dab95..0000000
--- a/doc/images/caravel.Screen Shot 2020-11-04 at 7.37.35 PM.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/caravel.Screen Shot 2020-11-04 at 7.38.22 PM.png b/doc/images/caravel.Screen Shot 2020-11-04 at 7.38.22 PM.png
deleted file mode 100644
index b8dfa86..0000000
--- a/doc/images/caravel.Screen Shot 2020-11-04 at 7.38.22 PM.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/caravel.caravel.nm.20201104.png b/doc/images/caravel.caravel.nm.20201104.png
deleted file mode 100644
index a597890..0000000
--- a/doc/images/caravel.caravel.nm.20201104.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/caravel.layout2.png b/doc/images/caravel.layout2.png
deleted file mode 100644
index 4a03281..0000000
--- a/doc/images/caravel.layout2.png
+++ /dev/null
Binary files differ
diff --git a/doc/images/caravel.screenshot_202011 5_05-03-48.png b/doc/images/caravel.screenshot_202011 5_05-03-48.png
deleted file mode 100644
index ef432a3..0000000
--- a/doc/images/caravel.screenshot_202011 5_05-03-48.png
+++ /dev/null
Binary files differ
diff --git a/doc/phase_frequency_detector/phase_frequency_detector_layout.png b/doc/phase_frequency_detector/phase_frequency_detector_layout.png
new file mode 100644
index 0000000..7174fcf
--- /dev/null
+++ b/doc/phase_frequency_detector/phase_frequency_detector_layout.png
Binary files differ
diff --git a/doc/rf_driver/rf_driver.png b/doc/rf_driver/rf_driver.png
new file mode 100644
index 0000000..b3056e3
--- /dev/null
+++ b/doc/rf_driver/rf_driver.png
Binary files differ
diff --git a/doc/rf_driver/rf_driver_cell_layout.png b/doc/rf_driver/rf_driver_cell_layout.png
new file mode 100644
index 0000000..5a9544c
--- /dev/null
+++ b/doc/rf_driver/rf_driver_cell_layout.png
Binary files differ
diff --git a/doc/vco_2-4GHz/vco_2-4GHz_layout.png b/doc/vco_2-4GHz/vco_2-4GHz_layout.png
new file mode 100644
index 0000000..338b602
--- /dev/null
+++ b/doc/vco_2-4GHz/vco_2-4GHz_layout.png
Binary files differ
diff --git a/xschem/bandgap_core/bandgap_core.sch b/xschem/bandgap_core/bandgap_core.sch
index da0b149..fa367c8 100644
--- a/xschem/bandgap_core/bandgap_core.sch
+++ b/xschem/bandgap_core/bandgap_core.sch
@@ -127,13 +127,14 @@
N 700 -410 1130 -410 { lab=q8}
N 950 -60 950 0 { lab=gnd}
N 890 0 950 0 {lab=gnd}
-N 380 -300 890 -300 { lab=q1}
N 1130 -410 1130 -290 { lab=q8}
N 1130 -150 1130 -90 { lab=#net5}
N 1420 -150 1420 0 { lab=gnd}
N 890 -370 890 -300 {lab=q1}
N 2760 -890 2780 -890 { lab=vdd}
N 2620 -890 2760 -890 { lab=vdd}
+N 20 -770 40 -770 { lab=en}
+N 20 -770 20 -680 { lab=en}
N 180 -890 180 -730 { lab=vdd}
N 2700 -780 2780 -780 { lab=cas}
N 1590 -790 2030 -790 { lab=ctat}
@@ -145,7 +146,8 @@
N 480 -390 520 -390 { lab=ptat}
N 480 -790 480 -390 { lab=ptat}
N 2700 -610 2780 -610 { lab=cas}
-N 630 -510 630 -450 { lab=#net3}
+N 380 -300 410 -300 { lab=q1}
+N 410 -300 890 -300 { lab=q1}
C {bandgap_opamp/bandgap_opamp.sym} 600 -390 0 1 {name=xop_ptat}
C {bandgap_opamp/bandgap_opamp.sym} 1920 -480 0 0 {name=xop_ctat}
C {lab_wire.sym} 800 -790 0 0 {name=l1 sig_type=std_logic lab=ptat}
@@ -154,8 +156,6 @@
C {lab_wire.sym} 800 -710 0 0 {name=l4 sig_type=std_logic lab=cas}
C {lab_wire.sym} 1220 -710 0 1 {name=l5 sig_type=std_logic lab=cas}
C {lab_wire.sym} 1510 -710 0 1 {name=l6 sig_type=std_logic lab=cas}
-C {lab_wire.sym} 2130 -710 0 0 {name=l7 sig_type=std_logic lab=gnd}
-C {lab_wire.sym} 2340 -710 0 0 {name=l8 sig_type=std_logic lab=gnd}
C {lab_wire.sym} 2130 -790 0 0 {name=l9 sig_type=std_logic lab=ptat}
C {lab_wire.sym} 2340 -790 0 0 {name=l10 sig_type=std_logic lab=ctat}
C {iopin.sym} 0 -890 0 1 {name=p1 lab=vdd}
@@ -163,14 +163,14 @@
C {opin.sym} 2780 -350 0 0 {name=p3 lab=ptat}
C {opin.sym} 2780 -480 0 0 {name=p4 lab=ctat}
C {opin.sym} 2780 -610 0 0 {name=p5 lab=cas}
-C {sky130_fd_pr/pfet_01v8.sym} 2640 -780 0 1 {name=Mtri_bias_cas[4:1]
+C {sky130_fd_pr/pfet_01v8.sym} 2640 -780 0 1 {name=Mtri_bias_cas
L=8
W=5
ad="'W * 0.29'" pd="'2 * (W + 0.29)'"
as="'W * 0.29'" ps="'2 * (W + 0.29)'"
nrd="'0.29 / W'" nrs="'0.29 / W'"
sa=0 sb=0 sd=0
-nf=1 mult=1
+nf=1 mult=4
model=pfet_01v8
spiceprefix=X
}
@@ -196,11 +196,20 @@
model=nfet_01v8_lvt
spiceprefix=X
}
-C {bandgap_cascurr_cell/bandgap_cascurr_cell.sym} 890 -750 0 0 {name=xcurr_ptat8[8:1] m=1}
-C {bandgap_cascurr_cell/bandgap_cascurr_cell.sym} 1130 -750 0 1 {name=xcurr_ptat1[8:1] m=1}
-C {bandgap_cascurr_cell/bandgap_cascurr_cell.sym} 1420 -750 0 1 {name=xcurr_ctat[32:1] m=1}
-C {bandgap_cascurr_cell/bandgap_cascurr_cell.sym} 2220 -750 0 0 {name=xcurr_cas_ptat[2:1] m=1}
-C {bandgap_cascurr_cell/bandgap_cascurr_cell.sym} 2430 -750 0 0 {name=xcurr_cas_ctat[2:1] m=1}
+C {ammeter.sym} 630 -480 0 0 {name=v2 current=8.6077e-11}
+C {bandgap_cascurr_cell/bandgap_cascurr_cell.sym} 890 -750 0 0 {name=xcurr_ptat8 m=8}
+C {bandgap_cascurr_cell/bandgap_cascurr_cell.sym} 1130 -750 0 1 {name=xcurr_ptat1 m=8}
+C {bandgap_cascurr_cell/bandgap_cascurr_cell.sym} 1420 -750 0 1 {name=xcurr_ctat m=32}
+C {bandgap_cascurr_cell/bandgap_cascurr_cell.sym} 2220 -750 0 0 {name=xcurr_cas_ptat m=2}
+C {bandgap_cascurr_cell/bandgap_cascurr_cell.sym} 2430 -750 0 0 {name=xcurr_cas_ctat m=2}
+C {sky130_fd_pr/pnp_05v5.sym} 870 -60 0 0 {name=Q1
+model="pnp_05v5_W3p40L3p40 m=1"
+spiceprefix=X}
+C {sky130_fd_pr/pnp_05v5.sym} 1150 -60 0 1 {name=Q8
+m=1
+model="pnp_05v5_W3p40L3p40 m=8"
+spiceprefix=X
+}
C {bandgap_bmr/bandgap_bmr.sym} 180 -680 0 0 {name=xbmr}
C {sky130_fd_pr/pfet_01v8_lvt.sym} 650 -670 0 1 {name=Mcurr_op_ptat
L=8
@@ -245,7 +254,7 @@
as="'W * 0.29'" ps="'2 * (W + 0.29)'"
nrd="'0.29 / W'" nrs="'0.29 / W'"
sa=0 sb=0 sd=0
-nf=1 mult=66
+nf=1 mult=71
model=pfet_01v8_lvt
spiceprefix=X
}
@@ -265,19 +274,20 @@
spiceprefix=X
}
C {ipin.sym} 0 -420 0 0 {name=p16 lab=start_n}
-C {sky130_fd_pr/pfet_01v8.sym} 2640 -700 0 1 {name=Mcas_bias[4:1]
+C {sky130_fd_pr/pfet_01v8.sym} 2640 -700 0 1 {name=Mcas_bias
L=0.35
W=5
ad="'W * 0.29'" pd="'2 * (W + 0.29)'"
as="'W * 0.29'" ps="'2 * (W + 0.29)'"
nrd="'0.29 / W'" nrs="'0.29 / W'"
sa=0 sb=0 sd=0
-nf=1 mult=1
+nf=1 mult=4
model=pfet_01v8
spiceprefix=X
}
C {lab_wire.sym} 2620 -610 0 1 {name=l27 sig_type=std_logic lab=cas}
C {lab_wire.sym} 1500 -500 0 1 {name=l28 sig_type=std_logic lab=ctat_r}
+C {bandgap_resistors/bandgap_resistors.sym} 1270 -220 0 0 {name=xres}
C {sky130_fd_pr/pfet_01v8_hvt.sym} 2800 -840 0 1 {name=Msw_en_cas
L=8
W=0.42
@@ -289,5 +299,9 @@
model=pfet_01v8_hvt
spiceprefix=X
}
+C {sky130_stdcells/inv_1.sym} 80 -770 0 0 {name=xen VGND=gnd VNB=gnd VPB=vdd VPWR=vdd prefix=sky130_fd_sc_hd__ }
+C {lab_wire.sym} 120 -770 0 1 {name=l25 sig_type=std_logic lab=en_n}
C {lab_wire.sym} 630 -330 2 0 {name=l31 sig_type=std_logic lab=en}
C {lab_wire.sym} 1890 -420 2 1 {name=l32 sig_type=std_logic lab=en}
+C {lab_wire.sym} 2130 -710 0 0 {name=l7 sig_type=std_logic lab=gnd}
+C {lab_wire.sym} 2340 -710 0 0 {name=l8 sig_type=std_logic lab=gnd}
