circuitpython/shared-module/keypad/KeyMatrix.c

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

183 lines
8.0 KiB
C
Raw Normal View History

2021-06-14 20:54:43 -04:00
/*
* This file is part of the Micro Python project, http://micropython.org/
*
* The MIT License (MIT)
*
* Copyright (c) 2021 Dan Halbert for Adafruit Industries
*
* 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>
2021-06-14 20:54:43 -04:00
#include "py/gc.h"
#include "py/runtime.h"
#include "shared-bindings/digitalio/DigitalInOut.h"
2021-06-16 15:27:59 -04:00
#include "shared-bindings/keypad/EventQueue.h"
#include "shared-bindings/keypad/KeyMatrix.h"
#include "shared-bindings/keypad/__init__.h"
2021-06-14 20:54:43 -04:00
#include "shared-bindings/util.h"
#include "supervisor/port.h"
#include "supervisor/shared/tick.h"
static mp_uint_t row_column_to_key_number(keypad_keymatrix_obj_t *self, mp_uint_t row, mp_uint_t column) {
return row * self->column_digitalinouts->len + column;
2021-06-14 20:54:43 -04:00
}
void common_hal_keypad_keymatrix_construct(keypad_keymatrix_obj_t *self, mp_uint_t num_row_pins, mcu_pin_obj_t *row_pins[], mp_uint_t num_column_pins, mcu_pin_obj_t *column_pins[], bool columns_to_anodes, mp_float_t interval, size_t max_events) {
2021-06-14 20:54:43 -04:00
mp_obj_t row_dios[num_row_pins];
2021-06-15 11:15:09 -04:00
for (size_t row = 0; row < num_row_pins; row++) {
2021-06-14 20:54:43 -04:00
digitalio_digitalinout_obj_t *dio = m_new_obj(digitalio_digitalinout_obj_t);
dio->base.type = &digitalio_digitalinout_type;
2021-06-15 11:15:09 -04:00
common_hal_digitalio_digitalinout_construct(dio, row_pins[row]);
2021-06-18 12:03:47 -04:00
common_hal_digitalio_digitalinout_switch_to_input(dio, columns_to_anodes ? PULL_UP : PULL_DOWN);
2021-06-15 11:15:09 -04:00
row_dios[row] = dio;
2021-06-14 20:54:43 -04:00
}
2021-06-15 11:15:09 -04:00
self->row_digitalinouts = mp_obj_new_tuple(num_row_pins, row_dios);
2021-06-14 20:54:43 -04:00
mp_obj_t column_dios[num_column_pins];
for (size_t column = 0; column < num_column_pins; column++) {
2021-06-14 20:54:43 -04:00
digitalio_digitalinout_obj_t *dio = m_new_obj(digitalio_digitalinout_obj_t);
dio->base.type = &digitalio_digitalinout_type;
common_hal_digitalio_digitalinout_construct(dio, column_pins[column]);
2021-06-18 12:03:47 -04:00
common_hal_digitalio_digitalinout_switch_to_input(dio, columns_to_anodes ? PULL_UP : PULL_DOWN);
column_dios[column] = dio;
2021-06-14 20:54:43 -04:00
}
self->column_digitalinouts = mp_obj_new_tuple(num_column_pins, column_dios);
2021-06-14 20:54:43 -04:00
self->currently_pressed = (bool *)gc_alloc(sizeof(bool) * num_row_pins * num_column_pins, false, false);
self->previously_pressed = (bool *)gc_alloc(sizeof(bool) * num_row_pins * num_column_pins, false, false);
2021-06-14 20:54:43 -04:00
2021-06-18 12:03:47 -04:00
self->columns_to_anodes = columns_to_anodes;
2021-06-16 15:27:59 -04:00
keypad_eventqueue_obj_t *events = m_new_obj(keypad_eventqueue_obj_t);
events->base.type = &keypad_eventqueue_type;
common_hal_keypad_eventqueue_construct(events, max_events);
self->events = events;
2021-06-14 20:54:43 -04:00
self->interval_ticks = (mp_uint_t)(interval * 1024); // interval * 1000 * (1024/1000)
self->last_scan_ticks = port_get_raw_ticks(NULL);
2021-06-16 13:29:38 -04:00
// Add self to the list of active keypad scanners.
keypad_register_scanner((keypad_scanner_obj_t *)self);
2021-06-15 11:15:09 -04:00
supervisor_enable_tick();
2021-06-14 20:54:43 -04:00
}
void common_hal_keypad_keymatrix_deinit(keypad_keymatrix_obj_t *self) {
if (common_hal_keypad_keymatrix_deinited(self)) {
return;
}
2021-06-16 13:29:38 -04:00
// Remove self from the list of active keypad scanners first.
keypad_deregister_scanner((keypad_scanner_obj_t *)self);
for (size_t row = 0; row < common_hal_keypad_keymatrix_get_row_count(self); row++) {
2021-06-14 20:54:43 -04:00
common_hal_digitalio_digitalinout_deinit(self->row_digitalinouts->items[row]);
}
self->row_digitalinouts = MP_ROM_NONE;
for (size_t column = 0; column < common_hal_keypad_keymatrix_get_column_count(self); column++) {
common_hal_digitalio_digitalinout_deinit(self->column_digitalinouts->items[column]);
2021-06-14 20:54:43 -04:00
}
self->column_digitalinouts = MP_ROM_NONE;
2021-06-14 20:54:43 -04:00
}
bool common_hal_keypad_keymatrix_deinited(keypad_keymatrix_obj_t *self) {
return self->row_digitalinouts == MP_ROM_NONE;
}
size_t common_hal_keypad_keymatrix_get_key_count(keypad_keymatrix_obj_t *self) {
return common_hal_keypad_keymatrix_get_row_count(self) * common_hal_keypad_keymatrix_get_column_count(self);
2021-06-14 20:54:43 -04:00
}
size_t common_hal_keypad_keymatrix_get_row_count(keypad_keymatrix_obj_t *self) {
2021-06-14 20:54:43 -04:00
return self->row_digitalinouts->len;
}
size_t common_hal_keypad_keymatrix_get_column_count(keypad_keymatrix_obj_t *self) {
return self->column_digitalinouts->len;
2021-06-14 20:54:43 -04:00
}
mp_uint_t common_hal_keypad_keymatrix_row_column_to_key_number(keypad_keymatrix_obj_t *self, mp_uint_t row, mp_uint_t column) {
return row_column_to_key_number(self, row, column);
}
void common_hal_keypad_keymatrix_key_number_to_row_column(keypad_keymatrix_obj_t *self, mp_uint_t key_number, mp_uint_t *row, mp_uint_t *column) {
const size_t num_columns = common_hal_keypad_keymatrix_get_column_count(self);
*row = key_number / num_columns;
*column = key_number % num_columns;
2021-06-14 20:54:43 -04:00
}
2021-06-16 15:27:59 -04:00
mp_obj_t common_hal_keypad_keymatrix_get_events(keypad_keymatrix_obj_t *self) {
return MP_OBJ_FROM_PTR(self->events);
}
void common_hal_keypad_keymatrix_reset(keypad_keymatrix_obj_t *self) {
const size_t key_count = common_hal_keypad_keymatrix_get_key_count(self);
supervisor_acquire_lock(&keypad_scanners_linked_list_lock);
memset(self->previously_pressed, false, key_count);
memset(self->currently_pressed, false, key_count);
supervisor_release_lock(&keypad_scanners_linked_list_lock);
}
2021-06-16 13:29:38 -04:00
void keypad_keymatrix_scan(keypad_keymatrix_obj_t *self) {
2021-06-14 20:54:43 -04:00
uint64_t now = port_get_raw_ticks(NULL);
if (now - self->last_scan_ticks < self->interval_ticks) {
2021-06-14 20:54:43 -04:00
// Too soon. Wait longer to debounce.
return;
}
self->last_scan_ticks = now;
2021-06-18 12:03:47 -04:00
// On entry, all pins are set to inputs with a pull-up or pull-down,
// depending on the diode orientation.
for (size_t row = 0; row < common_hal_keypad_keymatrix_get_row_count(self); row++) {
2021-06-18 12:03:47 -04:00
// Switch this row to an output and set level appropriately
// Set low if columns_to_anodes is true, else set high.
2021-06-14 20:54:43 -04:00
common_hal_digitalio_digitalinout_switch_to_output(
2021-06-18 12:03:47 -04:00
self->row_digitalinouts->items[row], !self->columns_to_anodes, DRIVE_MODE_PUSH_PULL);
2021-06-14 20:54:43 -04:00
for (size_t column = 0; column < common_hal_keypad_keymatrix_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;
2021-06-14 20:54:43 -04:00
// Get the current state, by reading whether the column got pulled to the row value or not.
2021-06-18 12:03:47 -04:00
// If low and columns_to_anodes is true, the key is pressed.
// If high and columns_to_anodes is false, the key is pressed.
2021-06-14 20:54:43 -04:00
const bool current =
common_hal_digitalio_digitalinout_get_value(self->column_digitalinouts->items[column]) !=
2021-06-18 12:03:47 -04:00
self->columns_to_anodes;
self->currently_pressed[key_number] = current;
2021-06-14 20:54:43 -04:00
// Record any transitions.
if (previous != current) {
keypad_eventqueue_record(self->events, key_number, current);
2021-06-14 20:54:43 -04:00
}
}
2021-06-18 12:03:47 -04:00
// Switch the row back to an input, pulled appropriately
common_hal_digitalio_digitalinout_switch_to_input(
self->row_digitalinouts->items[row], self->columns_to_anodes ? PULL_UP : PULL_DOWN);
2021-06-14 20:54:43 -04:00
}
}