Add instruction for SMA/BNC TTLs

Signed-off-by: Egor Savkin <es@m-labs.hk>

README.md

@@ -31,7 +31,7 @@ Tips for adding hardware instructions:
    (you can use `convert <INPUT IMAGE> -quality 80% -resize <width>x<height> <OUTPUT IMAGE>` for optimizing)
 3. Add link to the new chapter to the `src/SUMMARY.md`
 4. Do not forget to tell about all hidden/non-obvious obstacles and pitfalls
-5. Add testing steps, even if the "obvious" ones
+5. Add testing steps, even the "obvious" ones
 6. Add JSON sample if needed
 7. Add hardware setup (e.g. pins, switches) steps if needed
 8. View changed and added pages with `mdbook build` (see building instructions above)

src/SUMMARY.md

@@ -5,3 +5,4 @@
   - [Sinara 4624 AWG Phaser (Upconverter)](./hw/phaser_upconverter.md)
   - [Sinara 4456 synthesizer Mirny](./hw/mirny.md)
   - [SUServo (Sampler + Urukul)](./hw/suservo.md)
+  - [Sinara 2118 BNC-TTL / 2128 SMA-TTL](./hw/bnc_sma_ttl.md)

src/hw/bnc_sma_ttl.md

@@ -0,0 +1,58 @@
+# Sinara 2118 BNC-TTL / 2128 SMA-TTL
+
+* [Datasheet](https://m-labs.hk/docs/sinara-datasheets/2118-2128.pdf)
+* [Wiki DIO BNC](https://github.com/sinara-hw/DIO_BNC/wiki)
+* [Wiki DIO SMA](https://github.com/sinara-hw/DIO_SMA/wiki)
+
+## JSON
+
+```json
+{
+  "type": "dio",
+  "board": "DIO_BNC", // or "DIO_SMA"
+  "hw_rev": "vX.Y", // optional
+  "ports": [<port num>],
+  "edge_counter": <bool>,
+  "bank_direction_low": "input",
+  "bank_direction_high": "output"
+}
+```
+
+## Setup
+
+Switch the direction switches (shown on the picture below) according to customer requests.
+Remember, that you can only switch directions in groups of four.
+
+![](../img/dio_ttl_switches.jpg)
+
+## Test
+
+### Output
+
+```text
+*** Testing TTL outputs.
+Outputs are tested in groups of 4. Touch each TTL connector
+with the oscilloscope probe tip, and check that the number of
+pulses corresponds to its number in the group.
+Press ENTER when done.
+Testing TTL outputs: ttl0, ttl1, ttl2, ttl3.
+```
+
+1. Touch each TTL connector with the oscilloscope probe tip
+2. Adjust time- and voltage- scale and trigger threshold so that you clearly see square pulse
+3. Check that first TTL connector outputs 1 pulse, second - 2... fourth - 4 pulses
+4. Repeat 1-3 for each group of TTL connectors
+
+### Input
+
+```text
+*** Testing TTL inputs.
+TTL device to use as stimulus (default: ttl4): ttl4
+Connect ttl4 to ttl0. Press ENTER when done.
+...
+```
+
+1. Mount a wire with respective connector to the chosen TTL output (any should work, choose most convenient one)
+2. Connect the end of the wire to the TTL input requested by the `artiq_sinara_test` (you may use fast connector for SMA)
+3. Press ENTER and check that `artiq_sinara_test` prints `PASSED`
+4. Repeat 2-3 for every connector

src/hw/hardware.md

@@ -2,3 +2,6 @@
 
 In this section you will find instructions on testing the hardware.
 If you didn't find one for your hardware, feel free to compose and add your instruction.
+
+Useful links:
+* [Sinara Wiki](https://github.com/sinara-hw/meta/wiki)

src/hw/mirny.md

@@ -1,5 +1,7 @@
 # Sinara 4456 synthesizer Mirny
 
+[Wiki](https://github.com/sinara-hw/mirny/wiki)
+
 ## JSON
 
 ```json

src/hw/phaser_upconverter.md

@@ -1,30 +1,33 @@
 # Sinara 4624 AWG Phaser (Upconverter)
 
+[Wiki](https://github.com/sinara-hw/Phaser/wiki)
+
 ## JSON
 
 ```json
 {
-            "type": "phaser",
-            "hw_rev": "v1.1", // optional
-            "ports": [<port num>]
+   "type": "phaser",
+   "hw_rev": "vX.Y", // optional
+   "ports": [<port num>]
 }
 ```
 
 ## Testing
 
+After running `artiq_sinara_test`:
+
 ```text
 *** Testing Phaser DACs and 6 USER LEDs.
 Frequencies:
 phaser0 10+0 10+1 10+2 10+3 10+4 MHz
 ```
 
-After running `artiq_sinara_test`:
-
 1. Install gqrx `nix-shell -p gqrx`
 2. Connect bladeRF via USB cable only
 3. Run gqrx and choose `BladeRF #<number>...`
 4. Input rate 30000000, other settings are default
-5. When gqrx loaded, start DSP processing with frequency near 2.875 GHz + frequencies from `artiq_sinara_test` in `Receiver Options`
+5. When gqrx loaded, start DSP processing with frequency near 2.875 GHz + frequencies from `artiq_sinara_test`
+   in `Receiver Options`
 6. Connect the probe through attenuator to the Phaser's ports
 7. You should see 5 tones on `artiq_sinara_test`'s frequencies, like on the picture below
 

src/hw/suservo.md

@@ -21,6 +21,8 @@ On bottoms of each Urukul, switch first pins 1 and 2 to `ON`, as on the picture:
 
 ## Testing
 
+After running `artiq_sinara_test`:
+
 ```text
 *** Testing SUServos.
 Initializing modules...
@@ -49,7 +51,8 @@ Verify frequency and power behavior.
 1. Connect oscilloscope to the `urukul0` port and configure with time and voltage scale and trigger threshold
    so that you'll see sine wave, like on the picture: ![](../img/urukul_suservo_output_without_battery.jpg)
 2. Verify amplitude and frequency
-3. Apply 1.5V (connect the AA-battery) to the `sampler0` port, as on the picture: ![](../img/urukul_sampler_susevo_connections.jpg)
+3. Apply 1.5V (connect the AA-battery) to the `sampler0` port, as on the
+   picture: ![](../img/urukul_sampler_susevo_connections.jpg)
 4. You should see significant amplitude decrease, as in the picture: ![](../img/urukul_suservo_output_with_battery.jpg)
 5. Verify amplitude difference, and the frequency to be unchanged
 6. Repeat steps 1-5 for every available channel.