Commit 64798771 authored by mcattin's avatar mcattin

Update fmc_adc_100Ms_csr documentation.

Add more details on data format.



git-svn-id: http://svn.ohwr.org/fmc-adc-100m14b4cha/trunk@127 ddd67a1a-c8ad-4635-afe9-0b8a11d8f8e4
parent 91a35cb4
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
--------------------------------------------------------------------------------------- ---------------------------------------------------------------------------------------
-- File : ../rtl/fmc_adc_100Ms_csr.vhd -- File : ../rtl/fmc_adc_100Ms_csr.vhd
-- Author : auto-generated by wbgen2 from fmc_adc_100Ms_csr.wb -- Author : auto-generated by wbgen2 from fmc_adc_100Ms_csr.wb
-- Created : Thu Jan 26 10:14:03 2012 -- Created : Thu Aug 16 14:49:44 2012
-- Standard : VHDL'87 -- Standard : VHDL'87
--------------------------------------------------------------------------------------- ---------------------------------------------------------------------------------------
-- THIS FILE WAS GENERATED BY wbgen2 FROM SOURCE FILE fmc_adc_100Ms_csr.wb -- THIS FILE WAS GENERATED BY wbgen2 FROM SOURCE FILE fmc_adc_100Ms_csr.wb
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
* File : fmc_adc_100Ms_csr.h * File : fmc_adc_100Ms_csr.h
* Author : auto-generated by wbgen2 from fmc_adc_100Ms_csr.wb * Author : auto-generated by wbgen2 from fmc_adc_100Ms_csr.wb
* Created : Thu Jan 26 10:14:03 2012 * Created : Thu Aug 16 14:49:44 2012
* Standard : ANSI C * Standard : ANSI C
THIS FILE WAS GENERATED BY wbgen2 FROM SOURCE FILE fmc_adc_100Ms_csr.wb THIS FILE WAS GENERATED BY wbgen2 FROM SOURCE FILE fmc_adc_100Ms_csr.wb
......
...@@ -3350,7 +3350,7 @@ RESERVED ...@@ -3350,7 +3350,7 @@ RESERVED
<li><b> <li><b>
INT_TRIG_THRES INT_TRIG_THRES
</b>[<i>read/write</i>]: Threshold for internal trigger </b>[<i>read/write</i>]: Threshold for internal trigger
<br>Treated as two's complement and compared to raw ADC data <br>Treated as binary two's complement and compared to raw ADC data
</ul> </ul>
<a name="TRIG_DLY"></a> <a name="TRIG_DLY"></a>
<h3><a name="sect_3_4">3.4. Trigger delay</a></h3> <h3><a name="sect_3_4">3.4. Trigger delay</a></h3>
...@@ -3608,7 +3608,7 @@ TRIG_DLY[7:0] ...@@ -3608,7 +3608,7 @@ TRIG_DLY[7:0]
<li><b> <li><b>
TRIG_DLY TRIG_DLY
</b>[<i>read/write</i>]: Trigger delay value </b>[<i>read/write</i>]: Trigger delay value
<br>Delay to apply on the trigger in sampling clock ticks <br>Delay to apply on the trigger in sampling clock period.<br>The default clock frequency is 100MHz (period = 10ns).
</ul> </ul>
<a name="SW_TRIG"></a> <a name="SW_TRIG"></a>
<h3><a name="sect_3_5">3.5. Software trigger</a></h3> <h3><a name="sect_3_5">3.5. Software trigger</a></h3>
...@@ -3647,7 +3647,7 @@ SW_TRIG ...@@ -3647,7 +3647,7 @@ SW_TRIG
</tr> </tr>
</table> </table>
<p> <p>
Writing (anything) to this register generates a software trigger Writing (anything) to this register generates a software trigger.
</p> </p>
<table cellpadding=0 cellspacing=0 border=0> <table cellpadding=0 cellspacing=0 border=0>
<tr> <tr>
...@@ -4126,7 +4126,7 @@ NB[7:0] ...@@ -4126,7 +4126,7 @@ NB[7:0]
<li><b> <li><b>
NB NB
</b>[<i>read/write</i>]: Number of shots </b>[<i>read/write</i>]: Number of shots
<br>Number of shots required in multi-shot mode, set to one for single-shot mode <br>Number of shots required in multi-shot mode, set to one for single-shot mode.
<li><b> <li><b>
RESERVED RESERVED
</b>[<i>read/write</i>]: Reserved </b>[<i>read/write</i>]: Reserved
...@@ -4388,7 +4388,7 @@ TRIG_POS[7:0] ...@@ -4388,7 +4388,7 @@ TRIG_POS[7:0]
<li><b> <li><b>
TRIG_POS TRIG_POS
</b>[<i>read-only</i>]: Trigger address </b>[<i>read-only</i>]: Trigger address
<br>Trigger address in DDR memory.<br>Only used in single-shot mode <br>Trigger address in DDR memory.<br>Only used in single-shot mode.
</ul> </ul>
<a name="SR"></a> <a name="SR"></a>
<h3><a name="sect_3_8">3.8. Sample rate</a></h3> <h3><a name="sect_3_8">3.8. Sample rate</a></h3>
...@@ -4646,7 +4646,7 @@ DECI[7:0] ...@@ -4646,7 +4646,7 @@ DECI[7:0]
<li><b> <li><b>
DECI DECI
</b>[<i>read/write</i>]: Sample rate decimation </b>[<i>read/write</i>]: Sample rate decimation
<br>Decimation factor <br>Decimation factor. Takes one sample every N samples and discards the others (N = decimation factor).
<li><b> <li><b>
RESERVED RESERVED
</b>[<i>read/write</i>]: Reserved </b>[<i>read/write</i>]: Reserved
...@@ -5944,7 +5944,7 @@ VAL[7:0] ...@@ -5944,7 +5944,7 @@ VAL[7:0]
<li><b> <li><b>
VAL VAL
</b>[<i>read-only</i>]: Channel 1 current ADC value </b>[<i>read-only</i>]: Channel 1 current ADC value
<br>Current ADC raw value <br>Current ADC raw value. The format is binary two's complement.
<li><b> <li><b>
RESERVED RESERVED
</b>[<i>read-only</i>]: Reserved </b>[<i>read-only</i>]: Reserved
...@@ -6206,7 +6206,7 @@ VAL[7:0] ...@@ -6206,7 +6206,7 @@ VAL[7:0]
<li><b> <li><b>
VAL VAL
</b>[<i>read/write</i>]: Gain calibration for channel 1 </b>[<i>read/write</i>]: Gain calibration for channel 1
<br>Gain applied to all data coming from the ADC. <br>Gain applied to all data coming from the ADC.<br>Fixed point format:<br>Bit 15 = 2^0, bit 14 = 2^(-1), bit 13 = 2^(-2), ... , bit 1 = 2^(-14), bit 0 = 2^(-15)
<li><b> <li><b>
RESERVED RESERVED
</b>[<i>read/write</i>]: Reserved </b>[<i>read/write</i>]: Reserved
...@@ -6468,7 +6468,7 @@ VAL[7:0] ...@@ -6468,7 +6468,7 @@ VAL[7:0]
<li><b> <li><b>
VAL VAL
</b>[<i>read/write</i>]: Offset calibration for channel 1 </b>[<i>read/write</i>]: Offset calibration for channel 1
<br>Offset applied to all data coming from the ADC. <br>Offset applied to all data coming from the ADC. The format is binary two's complement.
<li><b> <li><b>
RESERVED RESERVED
</b>[<i>read/write</i>]: Reserved </b>[<i>read/write</i>]: Reserved
...@@ -6992,7 +6992,7 @@ VAL[7:0] ...@@ -6992,7 +6992,7 @@ VAL[7:0]
<li><b> <li><b>
VAL VAL
</b>[<i>read-only</i>]: Channel 2 current ACD value </b>[<i>read-only</i>]: Channel 2 current ACD value
<br>Current ADC raw value <br>Current ADC raw value. The format is binary two's complement.
<li><b> <li><b>
RESERVED RESERVED
</b>[<i>read-only</i>]: Reserved </b>[<i>read-only</i>]: Reserved
...@@ -7254,7 +7254,7 @@ VAL[7:0] ...@@ -7254,7 +7254,7 @@ VAL[7:0]
<li><b> <li><b>
VAL VAL
</b>[<i>read/write</i>]: Gain calibration for channel 2 </b>[<i>read/write</i>]: Gain calibration for channel 2
<br>Gain applied to all data coming from the ADC. <br>Gain applied to all data coming from the ADC.<br>Fixed point format:<br>Bit 15 = 2^0, bit 14 = 2^(-1), bit 13 = 2^(-2), ... , bit 1 = 2^(-14), bit 0 = 2^(-15)
<li><b> <li><b>
RESERVED RESERVED
</b>[<i>read/write</i>]: Reserved </b>[<i>read/write</i>]: Reserved
...@@ -7516,7 +7516,7 @@ VAL[7:0] ...@@ -7516,7 +7516,7 @@ VAL[7:0]
<li><b> <li><b>
VAL VAL
</b>[<i>read/write</i>]: Offset calibration for channel 2 </b>[<i>read/write</i>]: Offset calibration for channel 2
<br>Offset applied to all data coming from the ADC. <br>Offset applied to all data coming from the ADC. The format is binary two's complement.
<li><b> <li><b>
RESERVED RESERVED
</b>[<i>read/write</i>]: Reserved </b>[<i>read/write</i>]: Reserved
...@@ -8040,7 +8040,7 @@ VAL[7:0] ...@@ -8040,7 +8040,7 @@ VAL[7:0]
<li><b> <li><b>
VAL VAL
</b>[<i>read-only</i>]: Channel 3 current ADC value </b>[<i>read-only</i>]: Channel 3 current ADC value
<br>Current ADC raw value <br>Current ADC raw value. The format is binary two's complement.
<li><b> <li><b>
RESERVED RESERVED
</b>[<i>read-only</i>]: Reserved </b>[<i>read-only</i>]: Reserved
...@@ -8302,7 +8302,7 @@ VAL[7:0] ...@@ -8302,7 +8302,7 @@ VAL[7:0]
<li><b> <li><b>
VAL VAL
</b>[<i>read/write</i>]: Gain calibration for channel 3 </b>[<i>read/write</i>]: Gain calibration for channel 3
<br>Gain applied to all data coming from the ADC. <br>Gain applied to all data coming from the ADC.<br>Fixed point format:<br>Bit 15 = 2^0, bit 14 = 2^(-1), bit 13 = 2^(-2), ... , bit 1 = 2^(-14), bit 0 = 2^(-15)
<li><b> <li><b>
RESERVED RESERVED
</b>[<i>read/write</i>]: Reserved </b>[<i>read/write</i>]: Reserved
...@@ -8564,7 +8564,7 @@ VAL[7:0] ...@@ -8564,7 +8564,7 @@ VAL[7:0]
<li><b> <li><b>
VAL VAL
</b>[<i>read/write</i>]: Offset calibration for channel 3 </b>[<i>read/write</i>]: Offset calibration for channel 3
<br>Offset applied to all data coming from the ADC. <br>Offset applied to all data coming from the ADC. The format is binary two's complement.
<li><b> <li><b>
RESERVED RESERVED
</b>[<i>read/write</i>]: Reserved </b>[<i>read/write</i>]: Reserved
...@@ -9088,7 +9088,7 @@ VAL[7:0] ...@@ -9088,7 +9088,7 @@ VAL[7:0]
<li><b> <li><b>
VAL VAL
</b>[<i>read-only</i>]: Channel 4 current ADC value </b>[<i>read-only</i>]: Channel 4 current ADC value
<br>Current ADC raw value <br>Current ADC raw value. The format is binary two's complement.
<li><b> <li><b>
RESERVED RESERVED
</b>[<i>read-only</i>]: Reserved </b>[<i>read-only</i>]: Reserved
...@@ -9350,7 +9350,7 @@ VAL[7:0] ...@@ -9350,7 +9350,7 @@ VAL[7:0]
<li><b> <li><b>
VAL VAL
</b>[<i>read/write</i>]: Gain calibration for channel 4 </b>[<i>read/write</i>]: Gain calibration for channel 4
<br>Gain applied to all data coming from the ADC. <br>Gain applied to all data coming from the ADC.<br>Fixed point format:<br>Bit 15 = 2^0, bit 14 = 2^(-1), bit 13 = 2^(-2), ... , bit 1 = 2^(-14), bit 0 = 2^(-15)
<li><b> <li><b>
RESERVED RESERVED
</b>[<i>read/write</i>]: Reserved </b>[<i>read/write</i>]: Reserved
...@@ -9612,7 +9612,7 @@ VAL[7:0] ...@@ -9612,7 +9612,7 @@ VAL[7:0]
<li><b> <li><b>
VAL VAL
</b>[<i>read/write</i>]: Offset calibration for channel 4 </b>[<i>read/write</i>]: Offset calibration for channel 4
<br>Offset applied to all data coming from the ADC. <br>Offset applied to all data coming from the ADC. The format is binary two's complement.
<li><b> <li><b>
RESERVED RESERVED
</b>[<i>read/write</i>]: Reserved </b>[<i>read/write</i>]: Reserved
......
...@@ -189,7 +189,7 @@ peripheral { ...@@ -189,7 +189,7 @@ peripheral {
field { field {
name = "Threshold for internal trigger"; name = "Threshold for internal trigger";
description = "Treated as two's complement and compared to raw ADC data"; description = "Treated as binary two's complement and compared to raw ADC data";
prefix = "int_trig_thres"; prefix = "int_trig_thres";
type = SLV; type = SLV;
size = 16; size = 16;
...@@ -205,7 +205,7 @@ peripheral { ...@@ -205,7 +205,7 @@ peripheral {
field { field {
name = "Trigger delay value"; name = "Trigger delay value";
description = "Delay to apply on the trigger in sampling clock ticks"; description = "Delay to apply on the trigger in sampling clock period.\nThe default clock frequency is 100MHz (period = 10ns).";
type = SLV; type = SLV;
size = 32; size = 32;
access_bus = READ_WRITE; access_bus = READ_WRITE;
...@@ -215,7 +215,7 @@ peripheral { ...@@ -215,7 +215,7 @@ peripheral {
reg { reg {
name = "Software trigger"; name = "Software trigger";
description = "Writing (anything) to this register generates a software trigger"; description = "Writing (anything) to this register generates a software trigger.";
prefix = "sw_trig"; prefix = "sw_trig";
field { field {
...@@ -232,7 +232,7 @@ peripheral { ...@@ -232,7 +232,7 @@ peripheral {
field { field {
name = "Number of shots"; name = "Number of shots";
description = "Number of shots required in multi-shot mode, set to one for single-shot mode"; description = "Number of shots required in multi-shot mode, set to one for single-shot mode.";
prefix = "nb"; prefix = "nb";
type = SLV; type = SLV;
size = 16; size = 16;
...@@ -257,7 +257,7 @@ peripheral { ...@@ -257,7 +257,7 @@ peripheral {
field { field {
name = "Trigger address"; name = "Trigger address";
description = "Trigger address in DDR memory.\nOnly used in single-shot mode"; description = "Trigger address in DDR memory.\nOnly used in single-shot mode.";
type = SLV; type = SLV;
size = 32; size = 32;
access_bus = READ_ONLY; access_bus = READ_ONLY;
...@@ -271,7 +271,7 @@ peripheral { ...@@ -271,7 +271,7 @@ peripheral {
field { field {
name = "Sample rate decimation"; name = "Sample rate decimation";
description = "Decimation factor"; description = "Decimation factor. Takes one sample every N samples and discards the others (N = decimation factor).";
prefix = "deci"; prefix = "deci";
type = SLV; type = SLV;
size = 16; size = 16;
...@@ -364,7 +364,7 @@ peripheral { ...@@ -364,7 +364,7 @@ peripheral {
field { field {
name = "Channel 1 current ADC value"; name = "Channel 1 current ADC value";
description = "Current ADC raw value"; description = "Current ADC raw value. The format is binary two's complement.";
prefix = "val"; prefix = "val";
type = SLV; type = SLV;
size = 16; size = 16;
...@@ -390,7 +390,7 @@ peripheral { ...@@ -390,7 +390,7 @@ peripheral {
field { field {
name = "Gain calibration for channel 1"; name = "Gain calibration for channel 1";
description = "Gain applied to all data coming from the ADC."; description = "Gain applied to all data coming from the ADC.\nFixed point format:\nBit 15 = 2^0, bit 14 = 2^(-1), bit 13 = 2^(-2), ... , bit 1 = 2^(-14), bit 0 = 2^(-15)";
prefix = "val"; prefix = "val";
type = SLV; type = SLV;
size = 16; size = 16;
...@@ -415,7 +415,7 @@ peripheral { ...@@ -415,7 +415,7 @@ peripheral {
field { field {
name = "Offset calibration for channel 1"; name = "Offset calibration for channel 1";
description = "Offset applied to all data coming from the ADC."; description = "Offset applied to all data coming from the ADC. The format is binary two's complement.";
prefix = "val"; prefix = "val";
type = SLV; type = SLV;
size = 16; size = 16;
...@@ -465,7 +465,7 @@ peripheral { ...@@ -465,7 +465,7 @@ peripheral {
field { field {
name = "Channel 2 current ACD value"; name = "Channel 2 current ACD value";
description = "Current ADC raw value"; description = "Current ADC raw value. The format is binary two's complement.";
prefix = "val"; prefix = "val";
type = SLV; type = SLV;
size = 16; size = 16;
...@@ -491,7 +491,7 @@ peripheral { ...@@ -491,7 +491,7 @@ peripheral {
field { field {
name = "Gain calibration for channel 2"; name = "Gain calibration for channel 2";
description = "Gain applied to all data coming from the ADC."; description = "Gain applied to all data coming from the ADC.\nFixed point format:\nBit 15 = 2^0, bit 14 = 2^(-1), bit 13 = 2^(-2), ... , bit 1 = 2^(-14), bit 0 = 2^(-15)";
prefix = "val"; prefix = "val";
type = SLV; type = SLV;
size = 16; size = 16;
...@@ -516,7 +516,7 @@ peripheral { ...@@ -516,7 +516,7 @@ peripheral {
field { field {
name = "Offset calibration for channel 2"; name = "Offset calibration for channel 2";
description = "Offset applied to all data coming from the ADC."; description = "Offset applied to all data coming from the ADC. The format is binary two's complement.";
prefix = "val"; prefix = "val";
type = SLV; type = SLV;
size = 16; size = 16;
...@@ -566,7 +566,7 @@ peripheral { ...@@ -566,7 +566,7 @@ peripheral {
field { field {
name = "Channel 3 current ADC value"; name = "Channel 3 current ADC value";
description = "Current ADC raw value"; description = "Current ADC raw value. The format is binary two's complement.";
prefix = "val"; prefix = "val";
type = SLV; type = SLV;
size = 16; size = 16;
...@@ -592,7 +592,7 @@ peripheral { ...@@ -592,7 +592,7 @@ peripheral {
field { field {
name = "Gain calibration for channel 3"; name = "Gain calibration for channel 3";
description = "Gain applied to all data coming from the ADC."; description = "Gain applied to all data coming from the ADC.\nFixed point format:\nBit 15 = 2^0, bit 14 = 2^(-1), bit 13 = 2^(-2), ... , bit 1 = 2^(-14), bit 0 = 2^(-15)";
prefix = "val"; prefix = "val";
type = SLV; type = SLV;
size = 16; size = 16;
...@@ -617,7 +617,7 @@ peripheral { ...@@ -617,7 +617,7 @@ peripheral {
field { field {
name = "Offset calibration for channel 3"; name = "Offset calibration for channel 3";
description = "Offset applied to all data coming from the ADC."; description = "Offset applied to all data coming from the ADC. The format is binary two's complement.";
prefix = "val"; prefix = "val";
type = SLV; type = SLV;
size = 16; size = 16;
...@@ -667,7 +667,7 @@ peripheral { ...@@ -667,7 +667,7 @@ peripheral {
field { field {
name = "Channel 4 current ADC value"; name = "Channel 4 current ADC value";
description = "Current ADC raw value"; description = "Current ADC raw value. The format is binary two's complement.";
prefix = "val"; prefix = "val";
type = SLV; type = SLV;
size = 16; size = 16;
...@@ -693,7 +693,7 @@ peripheral { ...@@ -693,7 +693,7 @@ peripheral {
field { field {
name = "Gain calibration for channel 4"; name = "Gain calibration for channel 4";
description = "Gain applied to all data coming from the ADC."; description = "Gain applied to all data coming from the ADC.\nFixed point format:\nBit 15 = 2^0, bit 14 = 2^(-1), bit 13 = 2^(-2), ... , bit 1 = 2^(-14), bit 0 = 2^(-15)";
prefix = "val"; prefix = "val";
type = SLV; type = SLV;
size = 16; size = 16;
...@@ -718,7 +718,7 @@ peripheral { ...@@ -718,7 +718,7 @@ peripheral {
field { field {
name = "Offset calibration for channel 4"; name = "Offset calibration for channel 4";
description = "Offset applied to all data coming from the ADC."; description = "Offset applied to all data coming from the ADC. The format is binary two's complement.";
prefix = "val"; prefix = "val";
type = SLV; type = SLV;
size = 16; size = 16;
......
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