[Keyboard] gBoards GergoPlex (#13027)

* Moved gergoplex to seperate PR

* vendor + cformat

* Update keyboards/gboards/k/gergoplex/matrix.c

Co-Authored-By: Drashna Jaelre <drashna@live.com>

* lifiting keyboards up

* Update readme.md

* Update keyboards/gboards/gergoplex/config.h

Co-authored-by: Drashna Jaelre <drashna@live.com>

* remove English dicts

* cformatted

* Prettify keymap

* Remove via keymaps

Via doesn't support chords/combos, and this makes the keymap on such a
small keyboard quite uncomfortable and incomplete.

* Address QMK pull code review notes

* Cleanup (tabs, excessive comments)

* Fix keymap typos

* Use enum to define layers

* Multiple changes

 - got rid of LAYOUT_kc in favour of LAYOUT_split_3x5_3
 - fixed matrix custom C code to build with updated external dependencies (gcc)
 - fixed used combo docs

    keyboards/gboards/gergoplex/matrix.c:189:9: error: implicit declaration of function 'phex' [-Werror=implicit-function-declaration]
             phex(row);
             ^~~~
    keyboards/gboards/gergoplex/matrix.c:191:9: error: implicit declaration of function 'pbin_reverse16'; did you mean 'print_bin_reverse16'? [-Werror=implicit-function-declaration]
             pbin_reverse16(matrix_get_row(row));

* Remove apparently redundant macros

* Replace direct pin control with IO functions

* config mouse enable and combo delay fix

The default delay is 200:

    #define COMBO_TERM 200
        how long for the Combo keys to be detected. Defaults to TAPPING_TERM if not defined.

    tmk_core/common/action_tapping.h|22| 13:#    define TAPPING_TERM 200

* Remove redundant defines

* Unambiguously refer to the Special layer

* Fix formatting

* gboards/gergoplex set IGNORE_MOD_TAP_INTERRUPT

This solves my issue was with KC_CTL_A working correctly and it was set in @germ's repo
https://github.com/germ/qmk_firmware/blob/39c86e080dc04b68ee08387dcb5144c88cb44855/keyboards/gboards/k/gergoplex/config.h#L49

 https://beta.docs.qmk.fm/using-qmk/software-features/tap_hold#ignore-mod-tap-interrupt

* Name change

See commit 581368596ed

* Wording change

* Update keyboards/gboards/gergoplex/keymaps/default/keymap.c

Co-authored-by: Drashna Jaelre <drashna@live.com>

* Add copyright headers

* Fix debounce type

 | avr-gcc: error: .build/obj_gboards_gergoplex_default/quantum/debounce/eager_pr.o: No such file or directory

* Implement colemak-dhm keymap

Co-authored-by: Germ <jeremythegeek@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Brian Tannous <Brian@BrianTannous.com>

1 files changed, 241 insertions, 0 deletions

diff --git a/keyboards/gboards/gergoplex/matrix.c b/keyboards/gboards/gergoplex/matrix.c
new file mode 100644
index 0000000000..716390241a
--- /dev/null
+++ b/keyboards/gboards/gergoplex/matrix.c
@@ -0,0 +1,241 @@
+/*
+
+Copyright 2013 Oleg Kostyuk <cub.uanic@gmail.com>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#include "matrix.h"
+#include <stdint.h>
+#include <stdbool.h>
+#include <avr/io.h>
+#include "wait.h"
+#include "action_layer.h"
+#include "print.h"
+#include "debug.h"
+#include "util.h"
+#include "debounce.h"
+#include "gergoplex.h"
+
+#ifdef BALLER
+#    include <avr/interrupt.h>
+#    include "pointing_device.h"
+#endif
+
+#ifndef DEBOUNCE
+#    define DEBOUNCE 5
+#endif
+
+// ATmega pin defs
+#define ROW1 (1 << 6)
+#define ROW2 (1 << 5)
+#define ROW3 (1 << 4)
+#define ROW4 (1 << 1)
+
+/* matrix state(1:on, 0:off) */
+static matrix_row_t matrix[MATRIX_ROWS];
+/*
+ * matrix state(1:on, 0:off)
+ * contains the raw values without debounce filtering of the last read cycle.
+ */
+static matrix_row_t raw_matrix[MATRIX_ROWS];
+
+static const pin_t row_pins[MATRIX_COLS] = MATRIX_ROW_PINS;
+// Right-hand side only pins, the left side is controlled my MCP
+static const pin_t col_pins[MATRIX_ROWS_PER_SIDE] = MATRIX_COL_PINS;
+
+// Debouncing: store for each key the number of scans until it's eligible to
+// change.  When scanning the matrix, ignore any changes in keys that have
+// already changed in the last DEBOUNCE scans.
+
+static matrix_row_t read_cols(uint8_t row);
+static void         init_cols(void);
+static void         unselect_rows(void);
+static void         select_row(uint8_t row);
+
+static uint8_t mcp23018_reset_loop;
+
+__attribute__((weak)) void matrix_init_user(void) {}
+__attribute__((weak)) void matrix_scan_user(void) {}
+__attribute__((weak)) void matrix_scan_kb(void) { matrix_scan_user(); }
+
+void matrix_init(void) {
+    // initialize row and col
+    mcp23018_status = init_mcp23018();
+    unselect_rows();
+    init_cols();
+
+    // initialize matrix state: all keys off
+    for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
+        matrix[i]     = 0;
+        raw_matrix[i] = 0;
+    }
+
+    debounce_init(MATRIX_ROWS);
+    matrix_init_quantum();
+}
+void matrix_power_up(void) {
+    mcp23018_status = init_mcp23018();
+
+    unselect_rows();
+    init_cols();
+
+    // initialize matrix state: all keys off
+    for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
+        matrix[i] = 0;
+    }
+}
+
+// Reads and stores a row, returning
+// whether a change occurred.
+static inline bool store_raw_matrix_row(uint8_t index) {
+    matrix_row_t temp = read_cols(index);
+    if (raw_matrix[index] != temp) {
+        raw_matrix[index] = temp;
+        return true;
+    }
+    return false;
+}
+uint8_t matrix_scan(void) {
+    if (mcp23018_status) {  // if there was an error
+        if (++mcp23018_reset_loop == 0) {
+            // if (++mcp23018_reset_loop >= 1300) {
+            // since mcp23018_reset_loop is 8 bit - we'll try to reset once in 255 matrix scans
+            // this will be approx bit more frequent than once per second
+            print("trying to reset mcp23018\n");
+            mcp23018_status = init_mcp23018();
+            if (mcp23018_status) {
+                print("left side not responding\n");
+            } else {
+                print("left side attached\n");
+            }
+        }
+    }
+
+    bool changed = false;
+    for (uint8_t i = 0; i < MATRIX_ROWS_PER_SIDE; i++) {
+        // select rows from left and right hands
+        uint8_t left_index  = i;
+        uint8_t right_index = i + MATRIX_ROWS_PER_SIDE;
+        select_row(left_index);
+        select_row(right_index);
+
+        // we don't need a 30us delay anymore, because selecting a
+        // left-hand row requires more than 30us for i2c.
+
+        changed |= store_raw_matrix_row(left_index);
+        changed |= store_raw_matrix_row(right_index);
+
+        unselect_rows();
+    }
+
+    debounce(raw_matrix, matrix, MATRIX_ROWS, changed);
+    matrix_scan_quantum();
+
+#ifdef DEBUG_MATRIX
+    for (uint8_t c = 0; c < MATRIX_COLS; c++)
+        for (uint8_t r = 0; r < MATRIX_ROWS; r++)
+            if (matrix_is_on(r, c)) xprintf("r:%d c:%d \n", r, c);
+#endif
+
+    return 1;
+}
+
+bool matrix_is_modified(void)  // deprecated and evidently not called.
+{
+    return true;
+}
+
+inline bool         matrix_is_on(uint8_t row, uint8_t col) { return (matrix[row] & ((matrix_row_t)1 << col)); }
+inline matrix_row_t matrix_get_row(uint8_t row) { return matrix[row]; }
+
+void matrix_print(void) {
+    print("\nr/c 0123456789ABCDEF\n");
+    for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
+        print_hex8(row);
+        print(": ");
+        print_bin_reverse16(matrix_get_row(row));
+        print("\n");
+    }
+}
+uint8_t matrix_key_count(void) {
+    uint8_t count = 0;
+    for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
+        count += bitpop16(matrix[i]);
+    }
+    return count;
+}
+
+// Remember this means ROWS
+static void init_cols(void) {
+    for (uint8_t row = 0; row < MATRIX_COLS; row++) {
+      setPinInputHigh(row_pins[row]);
+    }
+}
+
+static matrix_row_t read_cols(uint8_t row) {
+    if (row < 5) {
+        if (mcp23018_status) {  // if there was an error
+            return 0;
+        } else {
+            uint8_t data    = 0;
+            mcp23018_status = i2c_start(I2C_ADDR_READ, I2C_TIMEOUT);
+            if (mcp23018_status) goto out;
+            mcp23018_status = i2c_read_nack(I2C_TIMEOUT);
+            if (mcp23018_status < 0) goto out;
+            data            = ~((uint8_t)mcp23018_status);
+            mcp23018_status = I2C_STATUS_SUCCESS;
+        out:
+            i2c_stop();
+
+#ifdef DEBUG_MATRIX
+            if (data != 0x00) xprintf("I2C: %d\n", data);
+#endif
+            return data;
+        }
+    } else {
+        return ~((((PINF & ROW4) >> 1) | ((PINF & (ROW1 | ROW2 | ROW3)) >> 3)) & 0xF);
+    }
+}
+
+// Row pin configuration
+static void unselect_rows(void) {
+    // no need to unselect on mcp23018, because the select step sets all
+    // the other row bits high, and it's not changing to a different direction
+
+    for (uint8_t col = 0; col < MATRIX_ROWS_PER_SIDE; col++) {
+      setPinInput(col_pins[col]);
+      writePinLow(col_pins[col]);
+    }
+}
+
+static void select_row(uint8_t row) {
+    if (row < 5) {
+        // select on mcp23018
+        if (mcp23018_status) {  // do nothing on error
+        } else {                // set active row low  : 0 // set other rows hi-Z : 1
+            mcp23018_status = i2c_start(I2C_ADDR_WRITE, I2C_TIMEOUT);
+            if (mcp23018_status) goto out;
+            mcp23018_status = i2c_write(GPIOA, I2C_TIMEOUT);
+            if (mcp23018_status) goto out;
+            mcp23018_status = i2c_write(0xFF & ~(1 << (row + 1)), I2C_TIMEOUT);
+            if (mcp23018_status) goto out;
+        out:
+            i2c_stop();
+        }
+    } else {
+        setPinOutput(col_pins[row - MATRIX_ROWS_PER_SIDE]);
+        writePinLow(col_pins[row - MATRIX_ROWS_PER_SIDE]);
+    }
+}