cal/drivers: fix startup delay / default cal / touch mapping for R3.5 HW (#65)

* cal/drivers: fix startup delay / default cal / touch mapping for R3.5 HW
* readme/ci: update
* cal/r3.5: update cal constants

Author: vk2seb

.github/workflows/main.yml

@@ -55,6 +55,32 @@ jobs:
           name: ubuntu-build-icebreaker-r33-touch.bin
           path: gateware/build/icebreaker/top.bin
 
+  ubuntu-build-icebreaker-r35:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: YosysHQ/setup-oss-cad-suite@v3
+      - run: git submodule update --init gateware/external/no2misc
+      - run: yosys --version
+      - run: make HW_REV=HW_R35 BOARD=icebreaker CORE=mirror -C gateware
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ubuntu-build-icebreaker-r35.bin
+          path: gateware/build/icebreaker/top.bin
+
+  ubuntu-build-icebreaker-r35-touch:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: YosysHQ/setup-oss-cad-suite@v3
+      - run: git submodule update --init gateware/external/no2misc
+      - run: yosys --version
+      - run: make HW_REV=HW_R35 BOARD=icebreaker CORE=touch_cv TOUCH=TOUCH_SENSE_ENABLED -C gateware
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ubuntu-build-icebreaker-r35-touch.bin
+          path: gateware/build/icebreaker/top.bin
+
   windows-build-icebreaker:
     runs-on: windows-latest
     defaults:

README.md

@@ -30,7 +30,7 @@ Some minor improvements over R3.3, with the following changes:
 - Improved noise performance and DC tracking by adding an additional onboard 3.3V regulator for the analog domain.
 - Touch IC switched from 8-channel to 16-channel version, so that the XRESET pin is not shared with one of the touch jacks.
 
-*Note: At this time, this Verilog repo is a bit out of date and refers to R3.3 everywhere, although I am shipping R3.5. The hardware is fully backward compatible besides the touch sensor mapping, so if you compile bitstreams for R3.3, they will work on R3.5. [See here for more details](https://apfaudio.github.io/tiliqua/quickstart/tlq_expander.html).*
+*Note: At this time, this Verilog repo is a bit out of date and refers to R3.3 in a few places, although I am shipping R3.5. I have tested this repository also on R3.5, just make sure to compile with `HW_R35`. [See here for more details](https://apfaudio.github.io/tiliqua/quickstart/tlq_expander.html).*
 
 # R3.3 hardware details
 
@@ -119,7 +119,7 @@ The project is split into 2 directories, [`hardware`](hardware) for the PCB/pane
 
 # R3.1 Hardware (no longer manufactured)
 
-The above README focuses on R3.3, which is currently being manufactured.
+The above README focuses on R3.3/R3.5, which is currently being manufactured.
 
 Revision R3.1 was sold out in 2023. It's no longer manufactured, however this repository still supports it if you use the `HW_REV=HW_R31` flag when building. I left some of the old photos here in case they are useful.
 

gateware/Makefile

@@ -1,6 +1,6 @@
 ALL_BOARDS = $(shell ls boards)
 ALL_CORES = $(shell basename --suffix=.sv -- cores/*.sv)
-ALL_HW_REV = "HW_R31 HW_R33"
+ALL_HW_REV = "HW_R31 HW_R33 HW_R35"
 ALL_TOUCH = "TOUCH_SENSE_DISABLED TOUCH_SENSE_ENABLED"
 
 CORE ?= mirror

gateware/cal/cal.sv

@@ -18,7 +18,9 @@
 
 module cal #(
     parameter W = 16, // sample width
-`ifdef HW_R33
+`ifdef HW_R35
+    parameter CAL_MEM_FILE = "cal/cal_mem_default_r35.hex"
+`elsif HW_R33
     parameter CAL_MEM_FILE = "cal/cal_mem_default_r33.hex"
 `else
     parameter CAL_MEM_FILE = "cal/cal_mem_default_r31.hex"

gateware/cal/cal_mem_default_r35.hex

@@ -0,0 +1,4 @@
+// Input calibration constants
+@00000000 380 500 380 500 380 500 380 500
+// Output calibration constants
+@00000008 80 398 80 398 80 398 80 398

gateware/drivers/cy8cmbr3108-cfg-r35.hex

@@ -0,0 +1,130 @@
+6e
+00
+a0
+3f
+00
+00
+00
+00
+00
+00
+ff
+ff
+00
+00
+80
+80
+80
+80
+80
+80
+80
+80
+00
+00
+00
+00
+00
+00
+00
+00
+04
+9f
+00
+b2
+94
+94
+00
+00
+00
+00
+00
+80
+05
+00
+00
+02
+00
+02
+00
+00
+00
+00
+00
+00
+00
+1e
+1e
+00
+00
+1e
+1e
+00
+00
+00
+01
+01
+00
+ff
+ff
+ff
+ff
+00
+00
+00
+00
+00
+00
+00
+10
+03
+00
+20
+00
+37
+01
+0f
+00
+0a
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+00
+cd
+92

gateware/drivers/pmod_i2c_master.sv

@@ -20,7 +20,11 @@ module pmod_i2c_master #(
     , parameter LED_CFG  = "drivers/pca9635-cfg.hex"
     , parameter LED_CFG_BYTES = 16'd26
 `ifdef TOUCH_SENSE_ENABLED
+`ifdef HW_R35
+    , parameter TOUCH_CFG  = "drivers/cy8cmbr3108-cfg-r35.hex"
+`else
     , parameter TOUCH_CFG  = "drivers/cy8cmbr3108-cfg.hex"
+`endif
     , parameter TOUCH_CFG_BYTES = 16'd130 // 0x80 + 2
 `endif
 )(
@@ -89,8 +93,13 @@ localparam I2C_DELAY1        = 0,
 `ifdef COCOTB_SIM
 localparam STARTUP_DELAY_BIT = 4;
 `else
+`ifdef HW_R35
+// HW R3.5 requires longer startup delay (~1.5s due to reset supervisor chip)
+localparam STARTUP_DELAY_BIT = 24;
+`else
 localparam STARTUP_DELAY_BIT = 17;
 `endif
+`endif
 
 logic [3:0] i2c_state = I2C_DELAY1;
 
@@ -135,7 +144,7 @@ logic       err_out;
 logic       ready;
 
 // Used for startup delay.
-logic [23:0] delay_cnt;
+logic [24:0] delay_cnt;
 
 // **Used for indicating POR failure of touch IC.**
 // Mitigation for `issues/59`: if CS2 of touch sense IC is shorted to ground
@@ -210,6 +219,8 @@ always_ff @(posedge clk) begin
                             cmd <= I2CMASTER_STOP;
 `ifdef HW_R33
                             i2c_state <= I2C_INIT_TOUCH1;
+`elsif HW_R35
+                            i2c_state <= I2C_INIT_TOUCH1;
 `else
                             // For R31, don't try initializing touch sense
                             i2c_state <= I2C_INIT_CODEC1;
@@ -554,16 +565,29 @@ always_ff @(posedge clk) begin
                                 i2c_state <= I2C_LED1;
                                 cmd <= I2CMASTER_STOP;
                             end else begin
+`ifdef HW_R35
+                                case (nsensor)
+                                    0: data_in <= 8'hC4;
+                                    1: data_in <= 8'hC8;
+                                    2: data_in <= 8'hCA;
+                                    3: data_in <= 8'hCC;
+                                    4: data_in <= 8'hCE;
+                                    5: data_in <= 8'hD0;
+                                    6: data_in <= 8'hD2;
+                                    7: data_in <= 8'hD4;
+                                endcase
+`else
                                 case (nsensor)
                                     0: data_in <= 8'hBA;
                                     1: data_in <= 8'hBC;
                                     2: data_in <= 8'hBE;
                                     3: data_in <= 8'hC0;
-                                    4: data_in <= 8'hC2;
-                                    5: data_in <= 8'hC4;
-                                    6: data_in <= 8'hC6;
-                                    7: data_in <= 8'hC8;
+                                    4: data_in <= 8'hC8;
+                                    5: data_in <= 8'hC6;
+                                    6: data_in <= 8'hC4;
+                                    7: data_in <= 8'hC2;
                                 endcase
+`endif
                             end
                         end
                         3: cmd <= I2CMASTER_STOP;
@@ -589,11 +613,10 @@ always_ff @(posedge clk) begin
                                 1: touch1 <= data_out;
                                 2: touch2 <= data_out;
                                 3: touch3 <= data_out;
-                                // R3.3 hw swaps last four vs R3.2 to improve PCB routing
-                                4: touch7 <= data_out;
-                                5: touch6 <= data_out;
-                                6: touch5 <= data_out;
-                                7: touch4 <= data_out;
+                                4: touch4 <= data_out;
+                                5: touch5 <= data_out;
+                                6: touch6 <= data_out;
+                                7: touch7 <= data_out;
                             endcase
                             cmd <= I2CMASTER_STOP;
                             i2c_state <= I2C_LED1;