Skip to content

F
FMC ADC 100M 14b 4cha - Gateware
Commit 010020ed authored by Matthieu Cattin's avatar Matthieu Cattin
Browse files
Options

doc: Updating documentation for release v3.0 (in progress).

parent 92c891b4
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 6486 additions and 1333 deletions
documentation/figures/Makefile
View file @ 010020ed
......@@ -2,17 +2,23 @@ SVG=$(wildcard *.svg)
PDF=$(SVG:.svg=.pdf)
.PHONY: all
all: $(PDF)
all: $(PDF) acq_fsm.pdf
%.pdf : %.svg
inkscape --without-gui $< -A $@
clean:
rm -f $(PDF)
rm -f acq_fsm.pdf
show:
$(info all svg: $(SVG))
$(info all pdf: $(PDF))
acq_fsm.pdf: acq_fsm.dia
dia -e acq_fsm.pdf acq_fsm.dia
# crop around front panel
# bbox origin is in bottom left corner of the page
# bbox unit is [points]
pdfcrop --bbox '50 550 550 780' acq_fsm.pdf acq_fsm.pdf
documentation/figures/memory_multi-shot.svg
View file @ 010020ed
This diff is collapsed.
documentation/figures/memory_single-shot.svg
View file @ 010020ed
......@@ -372,6 +372,33 @@
inkscape:vp_y="0 : 1000 : 0"
inkscape:vp_x="0 : 0.5 : 1"
sodipodi:type="inkscape:persp3d" />
<inkscape:perspective
id="perspective41641"
inkscape:persp3d-origin="0.5 : 0.33333333 : 1"
inkscape:vp_z="1 : 0.5 : 1"
inkscape:vp_y="0 : 1000 : 0"
inkscape:vp_x="0 : 0.5 : 1"
sodipodi:type="inkscape:persp3d" />
<marker
inkscape:stockid="TriangleOutM"
orient="auto"
refY="0"
refX="0"
id="marker13563"
style="overflow:visible">
<path
id="path13565"
d="m 5.77,0 -8.65,5 0,-10 8.65,5 z"
style="fill-rule:evenodd;stroke:#000000;stroke-width:1pt;marker-start:none"
transform="scale(0.4,0.4)" />
</marker>
<inkscape:perspective
id="perspective41675"
inkscape:persp3d-origin="0.5 : 0.33333333 : 1"
inkscape:vp_z="1 : 0.5 : 1"
inkscape:vp_y="0 : 1000 : 0"
inkscape:vp_x="0 : 0.5 : 1"
sodipodi:type="inkscape:persp3d" />
</defs>
<sodipodi:namedview
id="base"
......@@ -380,17 +407,17 @@
borderopacity="1.0"
inkscape:pageopacity="0.0"
inkscape:pageshadow="2"
inkscape:zoom="2.8"
inkscape:cx="297.50463"
inkscape:cy="44.217629"
inkscape:zoom="3.959798"
inkscape:cx="268.60124"
inkscape:cy="44.509913"
inkscape:document-units="px"
inkscape:current-layer="layer1"
showgrid="true"
inkscape:snap-global="true"
inkscape:window-width="1920"
inkscape:window-height="1123"
inkscape:window-height="1173"
inkscape:window-x="0"
inkscape:window-y="25"
inkscape:window-y="0"
inkscape:window-maximized="1">
<inkscape:grid
type="xygrid"
......@@ -467,29 +494,29 @@
y="278.86218">State machine :</tspan></text>
<path
style="fill:none;stroke:#000000;stroke-width:2;stroke-linecap:square;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-mid:none;marker-end:url(#DiamondM)"
d="m 359.84277,209.0198 0,-15.15762"
d="m 369.84277,209.0198 0,-15.15762"
id="path5968-5" />
<text
xml:space="preserve"
style="font-size:8px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:center;line-height:125%;writing-mode:lr-tb;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;font-family:Verdana;-inkscape-font-specification:Verdana"
x="136.49902"
x="130.49902"
y="183.86218"
id="text3291-3"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
x="136.49902"
x="130.49902"
y="183.86218"
id="tspan3295-7"
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:Monospace;-inkscape-font-specification:Monospace">ACQ_START</tspan></text>
<text
xml:space="preserve"
style="font-size:8px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:center;line-height:125%;writing-mode:lr-tb;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;font-family:Verdana;-inkscape-font-specification:Verdana"
x="259.63281"
x="251.63281"
y="184.36218"
id="text3291-3-7"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
x="259.63281"
x="251.63281"
y="184.36218"
id="tspan3295-7-8"
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:Monospace;-inkscape-font-specification:Monospace">TRIG</tspan></text>
......@@ -611,9 +638,9 @@
<rect
style="opacity:0.98999999;fill:#ff9900;fill-opacity:1;stroke:#000000;stroke-width:0.99999994;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
id="rect3287-5-2"
width="165"
width="175.16504"
height="25"
x="194.84277"
x="194.84279"
y="213.86218" />
<text
xml:space="preserve"
......@@ -665,5 +692,25 @@
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:3, 1;stroke-dashoffset:0"
d="m 249.84277,213.86218 0,25"
id="path12449" />
<text
xml:space="preserve"
style="font-size:8px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Verdana;-inkscape-font-specification:Verdana"
x="372.27344"
y="253.49658"
id="text3291-3-90-6-6-2"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
x="372.27344"
y="253.49658"
style="font-size:6px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;text-anchor:start;font-family:Monospace;-inkscape-font-specification:Monospace"
id="tspan12419-4">TRIGGER TIME-TAG</tspan></text>
<path
style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#marker13563)"
d="m 365.00781,242.36218 0,9 3,0"
id="path6333" />
<path
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:3, 1;stroke-dashoffset:0"
d="m 360.18637,214.36218 -0.17856,25"
id="path12451-4" />
</g>
</svg>
documentation/figures/memory_single-shot_overlap.svg
View file @ 010020ed
......@@ -216,6 +216,33 @@
inkscape:vp_y="0 : 1000 : 0"
inkscape:vp_x="0 : 0.5 : 1"
sodipodi:type="inkscape:persp3d" />
<inkscape:perspective
id="perspective41585"
inkscape:persp3d-origin="0.5 : 0.33333333 : 1"
inkscape:vp_z="1 : 0.5 : 1"
inkscape:vp_y="0 : 1000 : 0"
inkscape:vp_x="0 : 0.5 : 1"
sodipodi:type="inkscape:persp3d" />
<inkscape:perspective
id="perspective41607"
inkscape:persp3d-origin="0.5 : 0.33333333 : 1"
inkscape:vp_z="1 : 0.5 : 1"
inkscape:vp_y="0 : 1000 : 0"
inkscape:vp_x="0 : 0.5 : 1"
sodipodi:type="inkscape:persp3d" />
<marker
inkscape:stockid="TriangleOutM"
orient="auto"
refY="0"
refX="0"
id="marker13563"
style="overflow:visible">
<path
id="path13565"
d="m 5.77,0 -8.65,5 0,-10 8.65,5 z"
style="fill-rule:evenodd;stroke:#000000;stroke-width:1pt;marker-start:none"
transform="scale(0.4,0.4)" />
</marker>
</defs>
<sodipodi:namedview
id="base"
......@@ -225,15 +252,15 @@
inkscape:pageopacity="0.0"
inkscape:pageshadow="2"
inkscape:zoom="3.3272436"
inkscape:cx="273.64993"
inkscape:cy="75.718758"
inkscape:cx="289.41843"
inkscape:cy="38.403834"
inkscape:document-units="px"
inkscape:current-layer="layer1"
showgrid="true"
inkscape:window-width="1920"
inkscape:window-height="1123"
inkscape:window-height="1173"
inkscape:window-x="0"
inkscape:window-y="25"
inkscape:window-y="0"
inkscape:window-maximized="1">
<inkscape:grid
type="xygrid"
......@@ -310,29 +337,29 @@
y="362.91168">State machine :</tspan></text>
<path
style="fill:none;stroke:#000000;stroke-width:2;stroke-linecap:square;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;marker-mid:none;marker-end:url(#DiamondM)"
d="m 247.37252,293.13694 0,-15.15762"
d="m 257.40617,291.9117 0,-15.15762"
id="path5968-5" />
<text
xml:space="preserve"
style="font-size:8px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:center;line-height:125%;writing-mode:lr-tb;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;font-family:Verdana;-inkscape-font-specification:Verdana"
x="188.89738"
x="182.89738"
y="267.91168"
id="text3291-3"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
x="188.89738"
x="182.89738"
y="267.91168"
id="tspan3295-7"
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:Monospace;-inkscape-font-specification:Monospace">ACQ_START</tspan></text>
<text
xml:space="preserve"
style="font-size:8px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:center;line-height:125%;writing-mode:lr-tb;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;font-family:Verdana;-inkscape-font-specification:Verdana"
x="532.03119"
x="522.03119"
y="268.41168"
id="text3291-3-7"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
x="532.03119"
x="522.03119"
y="268.41168"
id="tspan3295-7-8"
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:Monospace;-inkscape-font-specification:Monospace">TRIG</tspan></text>
......@@ -400,7 +427,7 @@
style="opacity:0.98999999;fill:#a4a4a4;fill-opacity:1;stroke:#000000;stroke-width:1;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
id="rect3287-5"
width="425.13138"
height="25"
height="25.500013"
x="167.24113"
y="297.91168" />
<text
......@@ -446,10 +473,10 @@
<rect
style="opacity:0.98999999;fill:#ff9900;fill-opacity:1;stroke:#000000;stroke-width:0.99999994;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
id="rect3287-5-2"
width="80"
width="90.033676"
height="25"
x="167.37251"
y="298.13693" />
x="167.3725"
y="298.41168" />
<text
xml:space="preserve"
style="font-size:8px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:center;line-height:125%;writing-mode:lr-tb;text-anchor:middle;fill:#000000;fill-opacity:1;stroke:none;font-family:Verdana;-inkscape-font-specification:Verdana"
......@@ -471,7 +498,7 @@
style="opacity:0.98999999;fill:#ff9900;fill-opacity:1;stroke:#000000;stroke-width:0.99999994;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0"
id="rect3287-5-2-5"
width="120"
height="25"
height="25.274763"
x="472.37253"
y="298.13693" />
<text
......@@ -553,5 +580,25 @@
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:3, 1;stroke-dashoffset:0"
d="m 522.37251,298.13693 0,25"
id="path12449-3" />
<path
style="fill:none;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:3, 1;stroke-dashoffset:0"
d="m 247.40617,298.4117 0,25"
id="path12449-3-5" />
<text
xml:space="preserve"
style="font-size:8px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;font-family:Verdana;-inkscape-font-specification:Verdana"
x="259.67181"
y="337.18365"
id="text3291-3-90-6-6-2"
sodipodi:linespacing="125%"><tspan
sodipodi:role="line"
x="259.67181"
y="337.18365"
style="font-size:6px;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;text-align:start;text-anchor:start;font-family:Monospace;-inkscape-font-specification:Monospace"
id="tspan12419-4">TRIGGER TIME-TAG</tspan></text>
<path
style="fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1;marker-end:url(#marker13563)"
d="m 252.40617,326.04926 0,9 3,0"
id="path6333" />
</g>
</svg>
documentation/figures/spec_fw_arch.svg
View file @ 010020ed
This diff is collapsed.
documentation/figures/spec_fw_arch_module.svg
View file @ 010020ed
......@@ -219,14 +219,14 @@
inkscape:pageopacity="0.0"
inkscape:pageshadow="2"
inkscape:zoom="1.3589842"
inkscape:cx="403.37898"
inkscape:cy="222.86078"
inkscape:cx="415.50045"
inkscape:cy="194.61527"
inkscape:document-units="px"
inkscape:current-layer="layer1"
showgrid="false"
showgrid="true"
inkscape:window-width="1920"
inkscape:window-height="1123"
inkscape:window-x="0"
inkscape:window-x="1920"
inkscape:window-y="25"
inkscape:window-maximized="1"
inkscape:snap-grids="true">
......
documentation/manuals/firmware/spec/carrier_csr.tex
View file @ 010020ed
......@@ -118,7 +118,7 @@ Controls software reset of the mezzanine including the ddr interface and the tim
@item @code{0}
@tab R/W @tab
@code{FMC0_N}
@tab @code{0} @tab
@tab @code{X} @tab
State of the reset line
@item @code{31...1}
@tab R/W @tab
......@@ -128,6 +128,6 @@ Reserved
@end multitable
@multitable @columnfractions 0.15 0.85
@headitem Field @tab Description
@item @code{fmc0_n} @tab write 0: FMC is held in reset@* write 1: Normal FMC operation
@item @code{fmc0_n} @tab write 0: FMC is held in reset@* write 1: Normal FMC operation (default)
@item @code{reserved} @tab Ignore on read, write with 0's
@end multitable
documentation/manuals/firmware/svec/carrier_csr.tex
View file @ 010020ed
......@@ -112,12 +112,12 @@ Controls software reset of the mezzanines including the ddr interface and the ti
@item @code{0}
@tab R/W @tab
@code{FMC0_N}
@tab @code{0} @tab
@tab @code{X} @tab
State of the FMC 1 reset line
@item @code{1}
@tab R/W @tab
@code{FMC1_N}
@tab @code{0} @tab
@tab @code{X} @tab
State of the FMC 2 reset line
@item @code{31...2}
@tab R/W @tab
......@@ -127,7 +127,7 @@ Reserved
@end multitable
@multitable @columnfractions 0.15 0.85
@headitem Field @tab Description
@item @code{fmc0_n} @tab write 0: FMC is held in reset@* write 1: Normal FMC operation
@item @code{fmc1_n} @tab write 0: FMC is held in reset@* write 1: Normal FMC operation
@item @code{fmc0_n} @tab write 0: FMC is held in reset@* write 1: Normal FMC operation (default)
@item @code{fmc1_n} @tab write 0: FMC is held in reset@* write 1: Normal FMC operation (default)
@item @code{reserved} @tab Ignore on read, write with 0's
@end multitable
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment