scopes: Factor out TOGGLE_CALIBRATION_PIN().

[sigrok-firmware-fx2lafw.git] / sainsmart_dds120.c

diff --git a/sainsmart_dds120.c b/sainsmart_dds120.c
index 6748d47bd286cd1973efe7735c2a818ebd1ec00a..a45919619b4957485800d595ce990b1c58420394 100644 (file)
--- a/sainsmart_dds120.c
+++ b/sainsmart_dds120.c
@@ -15,8 +15,7 @@
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #include <fx2macros.h>
@@ -25,6 +24,12 @@
 #include <delay.h>
 #include <setupdat.h>
 
+#define SET_ANALOG_MODE() PA7 = 1
+
+/* Toggle the 1kHz calibration pin, only accurate up to ca. 8MHz. */
+/* Note: There's no PE2 as IOE is not bit-addressable (see TRM 15.2). */
+#define TOGGLE_CALIBRATION_PIN() IOE = IOE ^ 0x04
+
 /* Change to support as many interfaces as you need. */
 static BYTE altiface = 0;
 
@@ -65,13 +70,16 @@ void suspend_isr(void) __interrupt SUSPEND_ISR
 
 void timer2_isr(void) __interrupt TF2_ISR
 {
-       /* Toggle the 1kHz pin, only accurate up to ca 8MHz */
-       IOE = IOE^0x04;
+       TOGGLE_CALIBRATION_PIN();
+
        TF2 = 0;
 }
 
 /**
- * The gain stage is 2 stage approach. -6dB and -20dB on the first stage (attentuator). The second stage is then doing the gain by 3 different resistor values switched into the feedback loop.
+ * The gain stage is 2 stage approach. -6dB and -20dB on the first stage
+ * (attentuator). The second stage is then doing the gain by 3 different
+ * resistor values switched into the feedback loop.
+ *
  * #Channel 0:
  * PC1=1; PC2=0; PC3= 0 -> Gain x0.1 = -20dB
  * PC1=1; PC2=0; PC3= 1 -> Gain x0.2 = -14dB
@@ -79,6 +87,7 @@ void timer2_isr(void) __interrupt TF2_ISR
  * PC1=0; PC2=0; PC3= 0 -> Gain x0.5 =  -6dB
  * PC1=0; PC2=0; PC3= 1 -> Gain x1   =   0dB
  * PC1=0; PC2=1; PC3= 0 -> Gain x2   =  +6dB
+ *
  * #Channel 1:
  * PE1=1; PC4=0; PC5= 0 -> Gain x0.1 = -20dB 
  * PE1=1; PC4=0; PC5= 1 -> Gain x0.2 = -14dB
@@ -150,7 +159,6 @@ static BOOL set_voltage(BYTE channel, BYTE val)
        return TRUE;
 }
 
-
 /**
  * Each LSB in the nibble of the byte controls the coupling per channel.
  *
@@ -206,6 +214,8 @@ static void start_sampling(void)
 {
        int i;
 
+       SET_ANALOG_MODE();
+
        clear_fifo();
 
        for (i = 0; i < 1000; i++);
@@ -288,23 +298,26 @@ static BOOL set_samplerate(BYTE rate)
        IFCONFIG = samplerates[i].ifcfg;
 
        AUTOPTRSETUP = 7;
-       AUTOPTRH2 = 0xE4;
+       AUTOPTRH2 = 0xE4; /* 0xE400: GPIF waveform descriptor 0. */
        AUTOPTRL2 = 0x00;
 
        /*
         * The program for low-speed, e.g. 1 MHz, is:
-        * wait 24, CTL2=0, FIFO
-        * wait 23, CTL2=1
-        * jump 0, CTL2=1
+        * wait 24, CTLx=0, FIFO
+        * wait 23, CTLx=1
+        * jump 0, CTLx=1
         *
         * The program for 24 MHz is:
-        * wait 1, CTL2=0, FIFO
-        * jump 0, CTL2=1
+        * wait 1, CTLx=0, FIFO
+        * jump 0, CTLx=1
         *
         * The program for 30/48 MHz is:
-        * jump 0, CTL2=Z, FIFO, LOOP
+        * jump 0, CTLx=Z, FIFO, LOOP
+        *
+        * (CTLx is device-dependent, could be e.g. CTL0 or CTL2.)
         */
 
+       /* LENGTH / BRANCH 0-7 */
        EXTAUTODAT2 = samplerates[i].wait0;
        EXTAUTODAT2 = samplerates[i].wait1;
        EXTAUTODAT2 = 1;
@@ -314,24 +327,27 @@ static BOOL set_samplerate(BYTE rate)
        EXTAUTODAT2 = 0;
        EXTAUTODAT2 = 0;
 
+       /* OPCODE 0-7 */
        EXTAUTODAT2 = samplerates[i].opc0;
        EXTAUTODAT2 = samplerates[i].opc1;
-       EXTAUTODAT2 = 1;
+       EXTAUTODAT2 = 1; /* DATA=0 DP=1 */
        EXTAUTODAT2 = 0;
        EXTAUTODAT2 = 0;
        EXTAUTODAT2 = 0;
        EXTAUTODAT2 = 0;
        EXTAUTODAT2 = 0;
 
+       /* OUTPUT 0-7 */
        EXTAUTODAT2 = samplerates[i].out0;
-       EXTAUTODAT2 = 0x44;
-       EXTAUTODAT2 = 0x44;
-       EXTAUTODAT2 = 0x00;
-       EXTAUTODAT2 = 0x00;
-       EXTAUTODAT2 = 0x00;
-       EXTAUTODAT2 = 0x00;
-       EXTAUTODAT2 = 0x00;
+       EXTAUTODAT2 = 0x44; /* OE2=1, CTL2=1 */
+       EXTAUTODAT2 = 0x44; /* OE2=1, CTL2=1 */
+       EXTAUTODAT2 = 0;
+       EXTAUTODAT2 = 0;
+       EXTAUTODAT2 = 0;
+       EXTAUTODAT2 = 0;
+       EXTAUTODAT2 = 0;
 
+       /* LOGIC FUNCTION 0-7 */
        EXTAUTODAT2 = 0;
        EXTAUTODAT2 = 0;
        EXTAUTODAT2 = 0;
@@ -352,18 +368,18 @@ static BOOL set_calibration_pulse(BYTE fs)
        switch (fs) {
        case 0:         // 100Hz
                RCAP2L = -10000 & 0xff;
-               RCAP2H = (-10000 >> 8) & 0xff;
+               RCAP2H = (-10000 & 0xff00) >> 8;
                return TRUE;
        case 1:         // 1kHz
                RCAP2L = -1000 & 0xff;
-               RCAP2H = (-1000 >> 8) & 0xff;
+               RCAP2H = (-1000 & 0xff00) >> 8;
                return TRUE;
        case 10:        // 1kHz
-               RCAP2L = -100 & 0xff;
+               RCAP2L = (BYTE)(-100 & 0xff);
                RCAP2H = 0xff;
                return TRUE;
        case 50:        // 50kHz
-               RCAP2L = -20 & 0xff;
+               RCAP2L = (BYTE)(-20 & 0xff);
                RCAP2H = 0xff;
                return TRUE;
        default:
@@ -451,9 +467,11 @@ static void init(void)
        EP4CFG = 0;
        EP8CFG = 0;
 
+       SET_ANALOG_MODE();
+
        /* In idle mode tristate all outputs. */
-       GPIFIDLECTL = 0x00;
-       GPIFCTLCFG = 0x80;
+       GPIFIDLECTL = 0x00; /* Don't enable CTL0-5 outputs. */
+       GPIFCTLCFG = 0x80; /* TRICTL=1. CTL0-2: CMOS outputs, tri-statable. */
        GPIFWFSELECT = 0x00;
        GPIFREADYSTAT = 0x00;
 
@@ -487,7 +505,7 @@ static void main(void)
 
        /* Init timer2. */
        RCAP2L = -1000 & 0xff;
-       RCAP2H = (-1000 >> 8) & 0xff;
+       RCAP2H = (-1000 & 0xff00) >> 8;
        T2CON = 0;
        ET2 = 1;
        TR2 = 1;
@@ -501,7 +519,7 @@ static void main(void)
        OEC = 0xff;
        OEA = 0x80;
 
-       PA7 = 1;
+       SET_ANALOG_MODE();
 
        while (TRUE) {
                if (dosud) {
@@ -513,7 +531,7 @@ static void main(void)
                        dosuspend = FALSE;
                        do {
                                /* Make sure ext wakeups are cleared. */
-                               WAKEUPCS |= bmWU|bmWU2;
+                               WAKEUPCS |= bmWU | bmWU2;
                                SUSPEND = 1;
                                PCON |= 1;
                                __asm