From 313fc4cb8f4e41c921112d0b105b82ad5d8a653e Mon Sep 17 00:00:00 2001 From: frobiac Date: Fri, 10 Mar 2023 08:05:20 +0100 Subject: [Keyboard] frobiac custom boards and layout (#19883) --- keyboards/frobiac/blackbowl/blackbowl.h | 32 ++++++ keyboards/frobiac/blackbowl/config.h | 56 ++++++++++ keyboards/frobiac/blackbowl/info.json | 85 +++++++++++++++ .../frobiac/blackbowl/keymaps/default/keymap.c | 85 +++++++++++++++ keyboards/frobiac/blackbowl/matrix.c | 115 +++++++++++++++++++++ keyboards/frobiac/blackbowl/readme.md | 36 +++++++ keyboards/frobiac/blackbowl/rules.mk | 9 ++ 7 files changed, 418 insertions(+) create mode 100644 keyboards/frobiac/blackbowl/blackbowl.h create mode 100644 keyboards/frobiac/blackbowl/config.h create mode 100644 keyboards/frobiac/blackbowl/info.json create mode 100644 keyboards/frobiac/blackbowl/keymaps/default/keymap.c create mode 100644 keyboards/frobiac/blackbowl/matrix.c create mode 100644 keyboards/frobiac/blackbowl/readme.md create mode 100644 keyboards/frobiac/blackbowl/rules.mk (limited to 'keyboards/frobiac/blackbowl') diff --git a/keyboards/frobiac/blackbowl/blackbowl.h b/keyboards/frobiac/blackbowl/blackbowl.h new file mode 100644 index 0000000000..21ebee897e --- /dev/null +++ b/keyboards/frobiac/blackbowl/blackbowl.h @@ -0,0 +1,32 @@ +// Copyright 2023 @frobiac +// SPDX-License-Identifier: GPL-2.0-or-later + +#pragma once + +#include "quantum.h" +#include +#include +#include "i2c_master.h" +#include "wait.h" + +extern uint8_t expander_status; +extern uint8_t expander_input_pin_mask; +extern bool i2c_initialized; + +void init_blackbowl(void); +void init_expander(void); + +// clang-format off +#define I2C_TIMEOUT 100 +#define IODIRA 0x00 // i/o direction register +#define IODIRB 0x01 +#define GPPUA 0x0C // GPIO pull-up resistor register +#define GPPUB 0x0D +#define GPIOA 0x12 // general purpose i/o port register (write modifies OLAT) +#define GPIOB 0x13 +#define OLATA 0x14 // output latch register +#define OLATB 0x15 + +#define xxx KC_NO + +// clang-format on diff --git a/keyboards/frobiac/blackbowl/config.h b/keyboards/frobiac/blackbowl/config.h new file mode 100644 index 0000000000..cb13e69423 --- /dev/null +++ b/keyboards/frobiac/blackbowl/config.h @@ -0,0 +1,56 @@ +// Copyright 2012 Jun Wako +// Copyright 2013 Oleg Kostyuk +// Copyright 2017 Erin Call +// Copyright 2023 @frobiac +// SPDX-License-Identifier: GPL-2.0-or-later + +#pragma once + +#define MATRIX_ROWS 10 +#define MATRIX_COLS 4 +#define EXPANDER_COL_REGISTER GPIOA +#define EXPANDER_ROW_REGISTER GPIOB + +#ifdef PS2_MOUSE_ENABLE +# define PS2_MOUSE_USE_REMOTE_MODE +# define PS2_MOUSE_INIT_DELAY 1000 +#endif + +// clang-format off +#ifdef PS2_DRIVER_USART + +# define PS2_CLOCK_PIN D5 +# define PS2_DATA_PIN D2 + + /* synchronous, odd parity, 1-bit stop, 8-bit data, sample at falling edge */ + /* set DDR of CLOCK as input to be slave */ + #define PS2_USART_INIT() do { \ + PS2_CLOCK_DDR &= ~(1< +// Copyright 2017 Erin Call +// Copyright 2023 @frobiac +// SPDX-License-Identifier: GPL-2.0-or-later + +// This implements a matrix scan (lite) for the BlackBowl keyboard. +// Each side has a dedicated MCP23018 I2C expander. + +#include +#include +#include +#include "wait.h" +#include "action_layer.h" +#include "print.h" +#include "debug.h" +#include "util.h" +#include "matrix.h" +#include "blackbowl.h" +#include "i2c_master.h" +#include "timer.h" + +#define MATRIX_ROWS_PER_SIDE (MATRIX_ROWS / 2) +#define ROW_SHIFTER ((matrix_row_t)1) + +static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col); + +static uint8_t expander_reset_loop; +uint8_t expander_status; +const uint8_t expander_input_mask = ((1 << MATRIX_ROWS_PER_SIDE) - 1); // No special mapping, 5 bits [0..4] per side +bool i2c_initialized = false; + +static const uint8_t I2C_ADDR_RIGHT = 0x4E; +static const uint8_t I2C_ADDR_LEFT = 0x46; +static const uint8_t i2c_addr[] = {I2C_ADDR_RIGHT, I2C_ADDR_LEFT}; + +void matrix_init_custom(void) { + if (!i2c_initialized) { + i2c_init(); + wait_ms(1000); + } + + // Pin direction and pull-up depends on diode direction and column register: + // ROW2COL, GPIOA => input, output + uint8_t direction[2] = {0, expander_input_mask}; + uint8_t pullup[2] = {0, expander_input_mask}; + + for (uint8_t i = 0; i < 2; ++i) { + expander_status = i2c_writeReg(i2c_addr[i], IODIRA, direction, 2, I2C_TIMEOUT); + if (expander_status) return; + + expander_status = i2c_writeReg(i2c_addr[i], GPPUA, pullup, 2, I2C_TIMEOUT); + } +} + +bool matrix_scan_custom(matrix_row_t current_matrix[]) { + bool matrix_has_changed = false; + + if (expander_status) { // if there was an error + ++expander_reset_loop; + if (++expander_reset_loop == 0) { + // since expander_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 + matrix_init_custom(); + } + } + + for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) { + matrix_has_changed |= read_rows_on_col(current_matrix, current_col); + } + + return matrix_has_changed; +} + +static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col) { + bool matrix_changed = false; + uint8_t port = 0xFF & ~(1 << current_col); + uint8_t column_state[] = {0, 0}; + + // On both expanders: select col and read rows + for (size_t i = 0; i < 2; ++i) { + if (!expander_status) { + expander_status = i2c_writeReg(i2c_addr[i], EXPANDER_COL_REGISTER, &port, 1, I2C_TIMEOUT); + } + wait_us(30); + + if (expander_status) { + return false; + } + + expander_status = i2c_readReg(i2c_addr[i], EXPANDER_ROW_REGISTER, &column_state[i], 1, I2C_TIMEOUT); + column_state[i] = (~column_state[i]) & ((1 << MATRIX_ROWS_PER_SIDE) - 1); + } + + // now map rows 0..4 on each side to cumulative to 0..9 + uint16_t col_state = column_state[0] | ((column_state[1] << MATRIX_ROWS_PER_SIDE) /*& 0x3e0*/); + + for (uint8_t current_row = 0; current_row < MATRIX_ROWS; current_row++) { + // Store last value of row prior to reading + matrix_row_t last_row_value = current_matrix[current_row]; + + if (col_state & (1 << current_row)) { + // key closed; set state bit in matrix + current_matrix[current_row] |= (ROW_SHIFTER << current_col); + } else { + // key open; clear state bit in matrix + current_matrix[current_row] &= ~(ROW_SHIFTER << current_col); + } + + // Determine whether the matrix changed state + if ((last_row_value != current_matrix[current_row]) && !(matrix_changed)) { + matrix_changed = true; + } + } + return matrix_changed; +} diff --git a/keyboards/frobiac/blackbowl/readme.md b/keyboards/frobiac/blackbowl/readme.md new file mode 100644 index 0000000000..3150ca2046 --- /dev/null +++ b/keyboards/frobiac/blackbowl/readme.md @@ -0,0 +1,36 @@ +# frobiac/blackbowl + +![frobiac/blackbowl](https://i.imgur.com/nehpp3fh.jpeg) + +Custom 3D-printed and handwired 36-key split-keyboard with trackpoint developed in 2016. + +* Keyboard Maintainer: [frobiac](https://github.com/frobiac) +* Hardware Supported: Teensy-2.0, IBM Trackpoint, one MCP23018 per side, one RGB-LED +* Development History: [deskthority.net](https://deskthority.net/viewtopic.php?p=344785#p344785) +* Layout [Alpha KLE](http://www.keyboard-layout-editor.com/#/gists/6a6ec84d59fc346effbe894af159eabd) (same as BlackBowl) +* [Original Firmware](https://github.com/frobiac/adnw) + +Make example for this keyboard (after setting up your build environment): + + make frobiac/blackbowl + +Flashing example for this keyboard: + + make frobiac/blackbowl:flash + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). + + +The I2C code is based on the code from 'handwired/dactyl', +but reduced to ROW2COL and EXPANDER_COL_REGISTER=GPIOA define choices. +Adjustments were made for the two I2C addresses, one per side. + + +## Bootloader + +Enter the bootloader in 2 ways: + +* **Physical reset button**: Briefly press the button on the Teensy by inserting a small pin in the small hole in the switch plate +* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available + + diff --git a/keyboards/frobiac/blackbowl/rules.mk b/keyboards/frobiac/blackbowl/rules.mk new file mode 100644 index 0000000000..6004c37f9e --- /dev/null +++ b/keyboards/frobiac/blackbowl/rules.mk @@ -0,0 +1,9 @@ +CUSTOM_MATRIX = lite + +# project specific files +QUANTUM_LIB_SRC += i2c_master.c +SRC += matrix.c + +PS2_MOUSE_ENABLE = yes +PS2_ENABLE = yes +PS2_DRIVER = usart -- cgit v1.2.3