Add Cardputer keyboard support

Author: CDarius

ports/espressif/boards/m5stack_cardputer/mpconfigboard.mk

@@ -11,3 +11,6 @@ CIRCUITPY_ESP_FLASH_SIZE = 8MB
 CIRCUITPY_ESPCAMERA = 0
 
 CIRCUITPY_GIFIO = 1
+
+# Enable board-specific modules
+USER_C_MODULES = boards/m5stack_cardputer/usermods

ports/espressif/boards/m5stack_cardputer/usermods/cardputer/DemuxKeyMatrix.c

@@ -0,0 +1,155 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2024 CDarius
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#include <string.h>
+
+#include "py/gc.h"
+#include "py/runtime.h"
+#include "shared-bindings/digitalio/DigitalInOut.h"
+#include "shared-bindings/keypad/EventQueue.h"
+#include "shared-bindings/keypad/__init__.h"
+#include "shared-bindings/supervisor/__init__.h"
+#include "shared-bindings/util.h"
+#include "supervisor/port.h"
+#include "supervisor/shared/tick.h"
+#include "DemuxKeyMatrix.h"
+
+static void demuxkeymatrix_scan_now(void *self_in, mp_obj_t timestamp);
+static size_t demuxkeymatrix_get_key_count(void *self_in);
+
+static keypad_scanner_funcs_t keymatrix_funcs = {
+    .scan_now = demuxkeymatrix_scan_now,
+    .get_key_count = demuxkeymatrix_get_key_count,
+};
+
+static mp_uint_t row_column_to_key_number(cardputer_demuxkeymatrix_obj_t *self, mp_uint_t row, mp_uint_t column) {
+    return row * self->column_digitalinouts->len + column;
+}
+
+void common_hal_cardputer_demuxkeymatrix_construct(cardputer_demuxkeymatrix_obj_t *self, mp_uint_t num_row_addr_pins, const mcu_pin_obj_t *row_addr_pins[], mp_uint_t num_column_pins, const mcu_pin_obj_t *column_pins[], mp_float_t interval, size_t max_events) {
+
+    mp_obj_t row_addr_dios[num_row_addr_pins];
+    for (size_t row = 0; row < num_row_addr_pins; row++) {
+        digitalio_digitalinout_obj_t *dio =
+            mp_obj_malloc(digitalio_digitalinout_obj_t, &digitalio_digitalinout_type);
+        common_hal_digitalio_digitalinout_construct(dio, row_addr_pins[row]);
+        common_hal_digitalio_digitalinout_switch_to_output(dio, false, DRIVE_MODE_PUSH_PULL);
+        row_addr_dios[row] = dio;
+    }
+    self->row_addr_digitalinouts = mp_obj_new_tuple(num_row_addr_pins, row_addr_dios);
+
+    mp_obj_t column_dios[num_column_pins];
+    for (size_t column = 0; column < num_column_pins; column++) {
+        digitalio_digitalinout_obj_t *dio =
+            mp_obj_malloc(digitalio_digitalinout_obj_t, &digitalio_digitalinout_type);
+        dio->base.type = &digitalio_digitalinout_type;
+        common_hal_digitalio_digitalinout_construct(dio, column_pins[column]);
+        common_hal_digitalio_digitalinout_switch_to_input(dio, PULL_UP);
+        column_dios[column] = dio;
+    }
+    self->column_digitalinouts = mp_obj_new_tuple(num_column_pins, column_dios);
+
+    size_t num_rows = 1 << num_row_addr_pins;
+    self->currently_pressed = (bool *)m_malloc(sizeof(bool) * num_rows * num_column_pins);
+    self->previously_pressed = (bool *)m_malloc(sizeof(bool) * num_rows * num_column_pins);
+
+    self->funcs = &keymatrix_funcs;
+
+    keypad_construct_common((keypad_scanner_obj_t *)self, interval, max_events);
+}
+
+void common_hal_cardputer_demuxkeymatrix_deinit(cardputer_demuxkeymatrix_obj_t *self) {
+    if (common_hal_keypad_deinited(self)) {
+        return;
+    }
+
+    // Remove self from the list of active keypad scanners first.
+    keypad_deregister_scanner((keypad_scanner_obj_t *)self);
+
+    for (size_t row_addr = 0; row_addr < self->row_addr_digitalinouts->len; row_addr++) {
+        common_hal_digitalio_digitalinout_deinit(self->row_addr_digitalinouts->items[row_addr]);
+    }
+    self->row_addr_digitalinouts = MP_ROM_NONE;
+
+    for (size_t column = 0; column < self->column_digitalinouts->len; column++) {
+        common_hal_digitalio_digitalinout_deinit(self->column_digitalinouts->items[column]);
+    }
+    self->column_digitalinouts = MP_ROM_NONE;
+    common_hal_keypad_deinit_core(self);
+}
+
+size_t common_hal_cardputer_demuxkeymatrix_get_row_count(cardputer_demuxkeymatrix_obj_t *self) {
+    return 1 << self->row_addr_digitalinouts->len;
+}
+
+size_t common_hal_cardputer_demuxkeymatrix_get_column_count(cardputer_demuxkeymatrix_obj_t *self) {
+    return self->column_digitalinouts->len;
+}
+
+mp_uint_t common_hal_cardputer_demuxkeymatrix_row_column_to_key_number(cardputer_demuxkeymatrix_obj_t *self, mp_uint_t row, mp_uint_t column) {
+    return row_column_to_key_number(self, row, column);
+}
+
+void common_hal_cardputer_demuxkeymatrix_key_number_to_row_column(cardputer_demuxkeymatrix_obj_t *self, mp_uint_t key_number, mp_uint_t *row, mp_uint_t *column) {
+    const size_t num_columns = common_hal_cardputer_demuxkeymatrix_get_column_count(self);
+    *row = key_number / num_columns;
+    *column = key_number % num_columns;
+}
+
+static size_t demuxkeymatrix_get_key_count(void *self_in) {
+    cardputer_demuxkeymatrix_obj_t *self = self_in;
+    return common_hal_cardputer_demuxkeymatrix_get_column_count(self) * common_hal_cardputer_demuxkeymatrix_get_row_count(self);
+}
+
+static void demuxkeymatrix_scan_now(void *self_in, mp_obj_t timestamp) {
+    cardputer_demuxkeymatrix_obj_t *self = self_in;
+
+    for (size_t row = 0; row < common_hal_cardputer_demuxkeymatrix_get_row_count(self); row++) {
+        // Set the row address on demultiplexer
+        size_t mask = 0b00000001;
+        for (size_t row_addr_pin = 0; row_addr_pin < self->row_addr_digitalinouts->len; row_addr_pin++) {
+            digitalio_digitalinout_obj_t *dio = self->row_addr_digitalinouts->items[row_addr_pin];
+            common_hal_digitalio_digitalinout_set_value(dio, (mask & row) != 0);
+            mask = mask << 1;
+        }
+
+        for (size_t column = 0; column < common_hal_cardputer_demuxkeymatrix_get_column_count(self); column++) {
+            mp_uint_t key_number = row_column_to_key_number(self, row, column);
+            const bool previous = self->currently_pressed[key_number];
+            self->previously_pressed[key_number] = previous;
+
+            // Get the current state, by reading whether the column got pulled to the row value or not.
+            // If low, the key is pressed.
+            const bool current = !common_hal_digitalio_digitalinout_get_value(self->column_digitalinouts->items[column]);
+            self->currently_pressed[key_number] = current;
+
+            // Record any transitions.
+            if (previous != current) {
+                keypad_eventqueue_record(self->events, key_number, current, timestamp);
+            }
+        }
+    }
+}

ports/espressif/boards/m5stack_cardputer/usermods/cardputer/DemuxKeyMatrix.h

@@ -0,0 +1,55 @@
+/*
+ * This file is part of the Micro Python project, http://micropython.org/
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2024 CDarius
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef MICROPY_INCLUDED_SHARED_MODULE_CARDPUTER_DEMUXKEYMATRIX_H
+#define MICROPY_INCLUDED_SHARED_MODULE_CARDPUTER_DEMUXKEYMATRIX_H
+
+#include "py/obj.h"
+#include "py/objtuple.h"
+
+#include "common-hal/digitalio/DigitalInOut.h"
+#include "shared-module/keypad/__init__.h"
+#include "shared-module/keypad/EventQueue.h"
+
+typedef struct {
+    KEYPAD_SCANNER_COMMON_FIELDS;
+    mp_obj_tuple_t *row_addr_digitalinouts;
+    mp_obj_tuple_t *column_digitalinouts;
+} cardputer_demuxkeymatrix_obj_t;
+
+void cardputer_demuxkeymatrix_scan(cardputer_demuxkeymatrix_obj_t *self);
+
+void common_hal_cardputer_demuxkeymatrix_construct(cardputer_demuxkeymatrix_obj_t *self, mp_uint_t num_row_addr_pins, const mcu_pin_obj_t *row_addr_pins[], mp_uint_t num_column_pins, const mcu_pin_obj_t *column_pins[], mp_float_t interval, size_t max_events);
+
+void common_hal_cardputer_demuxkeymatrix_deinit(cardputer_demuxkeymatrix_obj_t *self);
+
+void common_hal_cardputer_demuxkeymatrix_key_number_to_row_column(cardputer_demuxkeymatrix_obj_t *self, mp_uint_t key_number, mp_uint_t *row, mp_uint_t *column);
+mp_uint_t common_hal_cardputer_demuxkeymatrix_row_column_to_key_number(cardputer_demuxkeymatrix_obj_t *self, mp_uint_t row, mp_uint_t column);
+
+size_t common_hal_cardputer_demuxkeymatrix_get_column_count(cardputer_demuxkeymatrix_obj_t *self);
+size_t common_hal_cardputer_demuxkeymatrix_get_row_count(cardputer_demuxkeymatrix_obj_t *self);
+
+#endif  // MICROPY_INCLUDED_SHARED_MODULE_CARDPUTER_DEMUXKEYMATRIX_H