diff options
author | ENDO Katsuhiro <ka2hiro@curlybracket.co.jp> | 2020-02-05 13:47:59 +0900 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-02-04 20:47:59 -0800 |
commit | aed18a5ff3b9eae14464aca2efb2a3ed029aea49 (patch) | |
tree | 273f54325beb2e7fcb0c46a3e7cb97608628e382 /keyboards | |
parent | 307be48de9a24a182420a6c42222906132035ea2 (diff) |
[Keyboard] Add a new keyboard Chidori. (#7496)
* [Keyboard] Add a new keyboard Chidori.
* Update keyboards/chidori/info.json
* Update keyboards/chidori/keymaps/default/keymap.c
* Update keyboards/chidori/chidori.h
* Update keyboards/chidori/keymaps/extended/keymap.c
* Update keyboards/chidori/keymaps/extended/keymap.c
* Update keyboards/chidori/keymaps/extended/keymap.c
* Update keyboards/chidori/keymaps/extended/keymap.c
* Update keyboards/chidori/keymaps/extended/keymap.c
* Update keyboards/chidori/keymaps/extended/keymap.c
* Update keyboards/chidori/keymaps/extended/keymap.c
* Update keyboards/chidori/readme.md
* Update keyboards/chidori/readme.md
* Update keyboards/chidori/readme.md
* Update keyboards/chidori/readme.md
* Update keyboards/chidori/rules.mk
* Update keyboards/chidori/rules.mk
* Update keyboards/chidori/rules.mk
* Update keyboards/chidori/rules.mk
* Update keyboards/chidori/rules.mk
* Update keyboards/chidori/rules.mk
* Update keyboards/chidori/rules.mk
* Update keyboards/chidori/rules.mk
* Update keyboards/chidori/rules.mk
* Update rules.mk
* Delete unnecesarry lines.
* Changes layer keys handing.
Diffstat (limited to 'keyboards')
-rw-r--r-- | keyboards/chidori/board.c | 366 | ||||
-rw-r--r-- | keyboards/chidori/board.h | 190 | ||||
-rw-r--r-- | keyboards/chidori/chidori.c | 15 | ||||
-rw-r--r-- | keyboards/chidori/chidori.h | 59 | ||||
-rw-r--r-- | keyboards/chidori/config.h | 253 | ||||
-rw-r--r-- | keyboards/chidori/info.json | 25 | ||||
-rw-r--r-- | keyboards/chidori/keymaps/default/config.h | 48 | ||||
-rw-r--r-- | keyboards/chidori/keymaps/default/keymap.c | 176 | ||||
-rw-r--r-- | keyboards/chidori/keymaps/default/readme.md | 1 | ||||
-rw-r--r-- | keyboards/chidori/keymaps/extended/config.h | 59 | ||||
-rw-r--r-- | keyboards/chidori/keymaps/extended/keymap.c | 181 | ||||
-rw-r--r-- | keyboards/chidori/keymaps/extended/readme.md | 1 | ||||
-rw-r--r-- | keyboards/chidori/matrix.c | 113 | ||||
-rw-r--r-- | keyboards/chidori/readme.md | 15 | ||||
-rw-r--r-- | keyboards/chidori/rules.mk | 44 | ||||
-rw-r--r-- | keyboards/chidori/usbconfig.h | 397 |
16 files changed, 1943 insertions, 0 deletions
diff --git a/keyboards/chidori/board.c b/keyboards/chidori/board.c new file mode 100644 index 0000000000..ff5b76a3af --- /dev/null +++ b/keyboards/chidori/board.c @@ -0,0 +1,366 @@ +/* Copyright 2019 ENDO Katsuhiro <ka2hiro@kagizaraya.jp> + * + * 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 <stdint.h> +#include <stdbool.h> +#include "wait.h" +#include "print.h" +#include "debug.h" +#include "matrix.h" +#include "quantum.h" +#include "board.h" +#include "i2c_master.h" + +static board_info_t boards[NUM_BOARDS] = BOARD_INFOS; +static board_info_t* master_board = NULL; + +static bool board_is_master(board_info_t* board); +static bool board_is_initialized(board_info_t* board); +static board_info_t* get_board_by_index(uint8_t board_index); +static uint8_t board_merge_led_config(board_info_t* board, uint8_t iodir); +static uint8_t board_merge_led_status(board_info_t* board, uint8_t data); +static void board_master_init(void); +static void board_slave_init(void); + +// +// board interface +// +static void board_select_master_row(board_info_t* board, uint8_t row); +static void board_unselect_master_row(board_info_t* board, uint8_t row); +static void board_unselect_master_rows(board_info_t* board); +static bool board_read_cols_on_master_row(board_info_t* board, matrix_row_t current_matrix[], uint8_t row); +static void board_set_master_led(board_info_t* board, uint8_t led_index, bool status); +static void board_select_slave_row(board_info_t* board, uint8_t row); +static void board_unselect_slave_row(board_info_t* board, uint8_t row); +static void board_unselect_slave_rows(board_info_t* board); +static bool board_read_cols_on_slave_row(board_info_t* board, matrix_row_t current_matrix[], uint8_t row); +static void board_set_slave_led(board_info_t* board, uint8_t led_index, bool status); + +static board_interface_t master_interface = {board_select_master_row, board_unselect_master_row, board_unselect_master_rows, board_read_cols_on_master_row, board_set_master_led}; +static board_interface_t slave_interface = {board_select_slave_row, board_unselect_slave_row, board_unselect_slave_rows, board_read_cols_on_slave_row, board_set_slave_led}; + +static board_interface_t* get_interface(board_info_t* board) { + if (board_is_master(board)) { + return &master_interface; + } + return &slave_interface; +} + +static void board_set_master_led(board_info_t* board, uint8_t led_index, bool status) { + pin_t pin = board->led_pins[led_index]; + board->led_status[led_index] = status; + setPinOutput(pin); + status ? writePinHigh(pin) : writePinLow(pin); +} + +static void board_set_slave_led(board_info_t* board, uint8_t led_index, bool status) { + board->led_status[led_index] = status; + uint8_t iodir = board_merge_led_config(board, 0xff); + uint8_t data = board_merge_led_status(board, 0x00); + i2c_writeReg(EXPANDER_ADDR(board->i2c_address), EXPANDER_IODIRB, (const uint8_t*)&iodir, sizeof(iodir), BOARD_I2C_TIMEOUT); + i2c_writeReg(EXPANDER_ADDR(board->i2c_address), EXPANDER_OLATB, (const uint8_t*)&data, sizeof(data), BOARD_I2C_TIMEOUT); +} + +static uint8_t board_merge_led_config(board_info_t* board, uint8_t iodir) { + for (uint8_t i = 0; i < NUM_LEDS; i++) { + iodir &= PIN2MASK(board->led_pins[i]); + } + return iodir; +} + +static bool board_slave_config(board_info_t* board) { + uint8_t set = 0xff; + uint8_t clear = 0x00; + i2c_status_t res = 0; + + // Set to input + res = i2c_writeReg(EXPANDER_ADDR(board->i2c_address), EXPANDER_IODIRA, (const uint8_t*)&set, sizeof(set), BOARD_I2C_TIMEOUT); + if (res < 0) return false; + // RESTRICTION: LEDs only on PORT B. + set = board_merge_led_config(board, set); + res = i2c_writeReg(EXPANDER_ADDR(board->i2c_address), EXPANDER_IODIRB, (const uint8_t*)&set, sizeof(set), BOARD_I2C_TIMEOUT); + if (res < 0) return false; + set = 0xff; + + // Pull up for input - enable + res = i2c_writeReg(EXPANDER_ADDR(board->i2c_address), EXPANDER_GPPUA, (const uint8_t*)&set, sizeof(set), BOARD_I2C_TIMEOUT); + if (res < 0) return false; + res = i2c_writeReg(EXPANDER_ADDR(board->i2c_address), EXPANDER_GPPUB, (const uint8_t*)&set, sizeof(set), BOARD_I2C_TIMEOUT); + if (res < 0) return false; + + // Disable interrupt + res = i2c_writeReg(EXPANDER_ADDR(board->i2c_address), EXPANDER_GPINTENA, (const uint8_t*)&clear, sizeof(clear), BOARD_I2C_TIMEOUT); + if (res < 0) return false; + res = i2c_writeReg(EXPANDER_ADDR(board->i2c_address), EXPANDER_GPINTENB, (const uint8_t*)&clear, sizeof(clear), BOARD_I2C_TIMEOUT); + if (res < 0) return false; + + // Polarity - same logic + res = i2c_writeReg(EXPANDER_ADDR(board->i2c_address), EXPANDER_IPOLA, (const uint8_t*)&clear, sizeof(clear), BOARD_I2C_TIMEOUT); + if (res < 0) return false; + res = i2c_writeReg(EXPANDER_ADDR(board->i2c_address), EXPANDER_IPOLB, (const uint8_t*)&clear, sizeof(clear), BOARD_I2C_TIMEOUT); + if (res < 0) return false; + + return true; +} + +static void board_slave_init(void) { + i2c_init(); + _delay_ms(500); + + for (uint8_t i = 0; i < NUM_BOARDS; i++) { + board_info_t* board = &boards[i]; + if (board_is_master(board)) { + continue; + } + if (i2c_start(EXPANDER_ADDR(board->i2c_address), BOARD_I2C_TIMEOUT) != I2C_STATUS_SUCCESS) { + continue; + } + i2c_stop(); + if (board_slave_config(board)) { + board->initialized = true; + } + } +} + +inline bool board_is_master(board_info_t* board) { + if (board) { + return board->master; + } + return false; +} + +inline uint8_t matrix_rows(void) { return MATRIX_ROWS; } + +inline uint8_t matrix2board(uint8_t row) { return row % NUM_ROWS; } + +inline uint8_t board_index(uint8_t row) { return row / NUM_ROWS; } + +static board_info_t* get_master_board(void) { + if (master_board == NULL) { + for (uint8_t i = 0; i < NUM_BOARDS; i++) { + if (boards[i].master) { + master_board = &boards[i]; + return master_board; + } + } + } + return NULL; +} + +inline bool board_is_initialized(board_info_t* board) { return board == NULL ? false : board->initialized; } + +static board_info_t* get_board_by_index(uint8_t board_index) { + if (board_index >= 0 && board_index < NUM_BOARDS) { + if (!board_is_initialized(&boards[board_index])) { + return NULL; + } + return &boards[board_index]; + } + return NULL; +} + +static board_info_t* get_board(uint8_t row) { + uint8_t idx = board_index(row); + if (idx >= 0 && idx < NUM_BOARDS) { + if (!board_is_initialized(&boards[idx])) { + return NULL; + } + return &boards[idx]; + } + return NULL; +} + +static uint8_t board_merge_led_status(board_info_t* board, uint8_t data) { + if (!board_is_initialized(board)) { + return data; + } + for (uint8_t i = 0; i < NUM_LEDS; i++) { + bool status = board->led_status[i]; + if (status) { + data |= (uint8_t)1 << PIN2INDEX(board->led_pins[i]); + } else { + data &= PIN2MASK(board->led_pins[i]); + } + } + return data; +} + +// +// Functions for slave +// +static uint8_t board_read_slave_cols(board_info_t* board) { + if (!board_is_initialized(board)) { + return 0xff; + } + uint8_t data = 0xff; + i2c_status_t res = i2c_readReg(EXPANDER_ADDR(board->i2c_address), EXPANDER_GPIOA, &data, sizeof(data), BOARD_I2C_TIMEOUT); + return (res < 0) ? 0xff : data; +} + +static void board_select_slave_row(board_info_t* board, uint8_t board_row) { + if (!board_is_initialized(board)) { + return; + } + uint8_t pin = board->row_pins[board_row]; + uint8_t iodir = board_merge_led_config(board, PIN2MASK(pin)); + uint8_t status = board_merge_led_status(board, PIN2MASK(pin)); + i2c_writeReg(EXPANDER_ADDR(board->i2c_address), EXPANDER_IODIRB, (const uint8_t*)&iodir, sizeof(iodir), BOARD_I2C_TIMEOUT); + i2c_writeReg(EXPANDER_ADDR(board->i2c_address), EXPANDER_OLATB, (const uint8_t*)&status, sizeof(status), BOARD_I2C_TIMEOUT); +} + +static void board_unselect_slave_rows(board_info_t* board) { + if (!board_is_initialized(board)) { + return; + } + uint8_t iodir = board_merge_led_config(board, 0xff); + uint8_t data = board_merge_led_status(board, 0x00); + i2c_writeReg(EXPANDER_ADDR(board->i2c_address), EXPANDER_IODIRB, (const uint8_t*)&iodir, sizeof(iodir), BOARD_I2C_TIMEOUT); + i2c_writeReg(EXPANDER_ADDR(board->i2c_address), EXPANDER_OLATB, (const uint8_t*)&data, sizeof(data), BOARD_I2C_TIMEOUT); +} + +static void board_unselect_slave_row(board_info_t* board, uint8_t board_row) { board_unselect_slave_rows(board); } + +/* + * row : matrix row (not board row) + */ +static bool board_read_cols_on_slave_row(board_info_t* board, matrix_row_t current_matrix[], uint8_t row) { + matrix_row_t last_row_value = current_matrix[row]; + current_matrix[row] = 0; + + uint8_t board_row = matrix2board(row); + board_select_slave_row(board, board_row); + wait_us(30); + + uint8_t cols = board_read_slave_cols(board); + for (uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) { + uint8_t pin = board->col_pins[col_index]; + uint8_t pin_state = cols & PIN2BIT(pin); + current_matrix[row] |= pin_state ? 0 : (1 << col_index); + } + board_unselect_slave_row(board, board_row); + + return (last_row_value != current_matrix[row]); +} + +// +// Functions for master board +// +static void board_select_master_row(board_info_t* board, uint8_t board_row) { + setPinOutput(board->row_pins[board_row]); + writePinLow(board->row_pins[board_row]); +} + +static void board_unselect_master_row(board_info_t* board, uint8_t board_row) { setPinInputHigh(board->row_pins[board_row]); } + +static void board_unselect_master_rows(board_info_t* board) { + if (!board) { + return; + } + for (uint8_t x = 0; x < NUM_ROWS; x++) { + setPinInput(board->row_pins[x]); + } +} + +/* + * row : matrix row (not board row) + */ +static bool board_read_cols_on_master_row(board_info_t* board, matrix_row_t current_matrix[], uint8_t row) { + matrix_row_t last_row_value = current_matrix[row]; + current_matrix[row] = 0; + + uint8_t board_row = matrix2board(row); + board_select_master_row(board, board_row); + wait_us(30); + + for (uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) { + uint8_t pin_state = readPin(board->col_pins[col_index]); + current_matrix[row] |= pin_state ? 0 : (1 << col_index); + } + board_unselect_master_row(board, board_row); + + return (last_row_value != current_matrix[row]); +} + +static void board_master_init(void) { + board_info_t* board = get_master_board(); + if (!board) { + return; + } + for (uint8_t x = 0; x < NUM_COLS; x++) { + setPinInputHigh(board->col_pins[x]); + } + board->initialized = true; +} + +static void board_setup(void) { + for (uint8_t i = 0; i < NUM_BOARDS; i++) { + board_info_t* board = &boards[i]; + board->interface = get_interface(board); + } +} + +// +// Public functions +// + +// NOTE: Do not call this while matrix scanning... +void board_set_led_by_index(uint8_t board_index, uint8_t led_index, bool status) { + board_info_t* board = get_board_by_index(board_index); + if (!board) return; + if (led_index < 0 || led_index > NUM_LEDS) return; + (*board->interface->set_led)(board, led_index, status); +} + +bool board_read_cols_on_row(matrix_row_t current_matrix[], uint8_t row) { + bool result = false; + board_info_t* board = get_board(row); + if (!board) { + return false; + } + result = (*board->interface->read_cols_on_row)(board, current_matrix, row); + return result; +} + +void board_select_row(uint8_t row) { + board_info_t* board = get_board(row); + if (!board) { + return; + } + uint8_t board_row = matrix2board(row); + (*board->interface->select_row)(board, board_row); +} + +void board_unselect_row(uint8_t row) { + board_info_t* board = get_board(row); + if (!board) { + return; + } + uint8_t board_row = matrix2board(row); + (*board->interface->unselect_row)(board, board_row); +} + +void board_unselect_rows(void) { + for (uint8_t i = 0; i < NUM_BOARDS; i++) { + board_info_t* board = &boards[i]; + (*board->interface->unselect_rows)(board); + } +} + +void board_init(void) { + board_setup(); + board_master_init(); + board_slave_init(); + board_unselect_rows(); +} diff --git a/keyboards/chidori/board.h b/keyboards/chidori/board.h new file mode 100644 index 0000000000..892ea6c0f1 --- /dev/null +++ b/keyboards/chidori/board.h @@ -0,0 +1,190 @@ +/* Copyright 2019 ENDO Katsuhiro <ka2hiro@kagizaraya.jp> + * + * 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/>. + */ +#pragma once + +#define NUM_ROWS 4 +#define NUM_COLS 6 +#define NUM_LEDS 2 + +#define LED_GREEN 0 +#define LED_YELLOW 1 + +typedef struct board_info_t board_info_t; +typedef struct board_interface_t board_interface_t; + +struct board_info_t { + bool master; + bool initialized; + uint8_t i2c_address; + pin_t row_pins[NUM_ROWS]; + pin_t col_pins[NUM_COLS]; + pin_t led_pins[NUM_LEDS]; + bool led_status[NUM_LEDS]; + board_interface_t* interface; +}; + +struct board_interface_t { + void (*select_row)(board_info_t* board, uint8_t row); + void (*unselect_row)(board_info_t* board, uint8_t row); + void (*unselect_rows)(board_info_t* board); + bool (*read_cols_on_row)(board_info_t* board, matrix_row_t current_matrix[], uint8_t row); + void (*set_led)(board_info_t* board, uint8_t led_index, bool status); +}; + +#define BOARD_I2C_TIMEOUT 20 + +#define GPA0 0x00 +#define GPA1 0x01 +#define GPA2 0x02 +#define GPA3 0x03 +#define GPA4 0x04 +#define GPA5 0x05 +#define GPA6 0x06 +#define GPA7 0x07 +#define GPB0 0x08 +#define GPB1 0x09 +#define GPB2 0x0A +#define GPB3 0x0B +#define GPB4 0x0C +#define GPB5 0x0D +#define GPB6 0x0E +#define GPB7 0x0F + +//#define PORTA 0x00 +//#define PORTB 0x01 +#define PORT_MASK 0x08 +#define PIN_MASK 0x07 + +#define PIN2REGISTER(reg, pin) (reg & ((pin & PORT_MASK) >> 3)) +#define PIN2PORT(pin) ((pin & PORT_MASK) >> 3) +#define PIN2MASK(pin) (~(1 << PIN2INDEX(pin))) +#define PIN2INDEX(pin) (pin & ~PORT_MASK) +#define PIN2BIT(pin) (1 << PIN2INDEX(pin)) + +#define EXPANDER_ADDR(addr) (addr << 1) + +#define EXPANDER_IODIR(pin) (0x00 | PIN2PORT(pin)) +#define EXPANDER_IPOL(pin) (0x02 | PIN2PORT(pin)) +#define EXPANDER_GPINTEN(pin) (0x04 | PIN2PORT(pin)) +#define EXPANDER_DEFVAL(pin) (0x06 | PIN2PORT(pin)) +#define EXPANDER_INTCON(pin) (0x08 | PIN2PORT(pin)) +#define EXPANDER_IOCON(pin) (0x0A | PIN2PORT(pin)) +#define EXPANDER_GPPU(pin) (0x0C | PIN2PORT(pin)) +#define EXPANDER_INTF(pin) (0x0E | PIN2PORT(pin)) +#define EXPANDER_INTCAP(pin) (0x10 | PIN2PORT(pin)) +#define EXPANDER_GPIO(pin) (0x12 | PIN2PORT(pin)) +#define EXPANDER_OLAT(pin) (0x14 | PIN2PORT(pin)) + +#define EXPANDER_IODIRA 0x00 +#define EXPANDER_IODIRB 0x01 +#define EXPANDER_IPOLA 0x02 +#define EXPANDER_IPOLB 0x03 +#define EXPANDER_GPINTENA 0x04 +#define EXPANDER_GPINTENB 0x05 +#define EXPANDER_DEFVALA 0x06 +#define EXPANDER_DEFVALB 0x07 +#define EXPANDER_INTCONA 0x08 +#define EXPANDER_INTCONB 0x09 +#define EXPANDER_IOCONA 0x0A +#define EXPANDER_IOCONB 0x0B +#define EXPANDER_GPPUA 0x0C +#define EXPANDER_GPPUB 0x0D +#define EXPANDER_INTFA 0x0E +#define EXPANDER_INTFB 0x0F +#define EXPANDER_INTCAPA 0x10 +#define EXPANDER_INTCAPB 0x11 +#define EXPANDER_GPIOA 0x12 +#define EXPANDER_GPIOB 0x13 +#define EXPANDER_OLATA 0x14 +#define EXPANDER_OLATB 0x15 + +// +// Default board config +// +#ifndef NUM_BOARDS +# define NUM_BOARDS 2 +#endif + +// clang-format off +#ifndef BOARD_INFOS +#if NUM_BOARDS == 2 +#define BOARD_INFOS \ +{ \ + { \ + true, \ + false, \ + 0x00, \ + { D4, D5, D6, D7 }, \ + { D1, D0, C3, C2, C1, C0 }, \ + { B1, B2 }, \ + { false, false }, \ + NULL \ + }, \ + { \ + false, \ + false, \ + 0x20, \ + { GPB4, GPB5, GPB6, GPB7 }, \ + { GPA7, GPA6, GPA5, GPA4, GPA3, GPA2 }, \ + { GPB0, GPB1 }, \ + { false, false }, \ + NULL \ + }, \ +} +#elif NUM_BOARDS == 3 +#define BOARD_INFOS \ +{ \ + { \ + true, \ + false, \ + 0x00, \ + { D4, D5, D6, D7 }, \ + { D1, D0, C3, C2, C1, C0 }, \ + { B1, B2 }, \ + { false, false }, \ + NULL \ + }, \ + { \ + false, \ + false, \ + 0x20, \ + { GPB4, GPB5, GPB6, GPB7 }, \ + { GPA7, GPA6, GPA5, GPA4, GPA3, GPA2 }, \ + { GPB0, GPB1 }, \ + { false, false }, \ + NULL \ + }, \ + { \ + false, \ + false, \ + 0x21, \ + { GPB4, GPB5, GPB6, GPB7 }, \ + { GPA7, GPA6, GPA5, GPA4, GPA3, GPA2 }, \ + { GPB0, GPB1 }, \ + { false, false }, \ + NULL \ + }, \ +} +#endif +#endif +// clang-format on + +void board_set_led_by_index(uint8_t board_index, uint8_t led_index, bool status); +bool board_read_cols_on_row(matrix_row_t current_matrix[], uint8_t row); +void board_select_row(uint8_t row); +void board_unselect_row(uint8_t row); +void board_unselect_rows(void); +void board_init(void); diff --git a/keyboards/chidori/chidori.c b/keyboards/chidori/chidori.c new file mode 100644 index 0000000000..a3b6f2c041 --- /dev/null +++ b/keyboards/chidori/chidori.c @@ -0,0 +1,15 @@ +/* Copyright 2019 ENDO Katsuhiro <ka2hiro@kagizaraya.jp> + * + * 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/>. + */ diff --git a/keyboards/chidori/chidori.h b/keyboards/chidori/chidori.h new file mode 100644 index 0000000000..efaff71948 --- /dev/null +++ b/keyboards/chidori/chidori.h @@ -0,0 +1,59 @@ +/* Copyright 2019 ENDO Katsuhiro <ka2hiro@kagizaraya.jp> + * + * 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/>. + */ +#pragma once + +#include "quantum.h" + +// clang-format off +#define LAYOUT( \ + L01, L02, L03, L04, L05, L06, R01, R02, R03, R04, R05, R06, \ + L07, L08, L09, L10, L11, L12, R07, R08, R09, R10, R11, R12, \ + L13, L14, L15, L16, L17, L18, R13, R14, R15, R16, R17, R18, \ + L19, L20, L21, L22, L23, L24, R19, R20, R21, R22, R23, R24 \ + ) \ + { \ + { L01, L02, L03, L04, L05, L06 }, \ + { L07, L08, L09, L10, L11, L12 }, \ + { L13, L14, L15, L16, L17, L18 }, \ + { L19, L20, L21, L22, L23, L24 }, \ + { R01, R02, R03, R04, R05, R06 }, \ + { R07, R08, R09, R10, R11, R12 }, \ + { R13, R14, R15, R16, R17, R18 }, \ + { R19, R20, R21, R22, R23, R24 } \ + } + +#define LAYOUT_extended( \ + L01, L02, L03, L04, L05, L06, M01, M02, M03, M04, M05, M06, R01, R02, R03, R04, R05, R06, \ + L07, L08, L09, L10, L11, L12, M07, M08, M09, M10, M11, M12, R07, R08, R09, R10, R11, R12, \ + L13, L14, L15, L16, L17, L18, M13, M14, M15, M16, M17, M18, R13, R14, R15, R16, R17, R18, \ + L19, L20, L21, L22, L23, L24, M19, M20, M21, M22, M23, M24, R19, R20, R21, R22, R23, R24 \ + ) \ + { \ + { L01, L02, L03, L04, L05, L06 }, \ + { L07, L08, L09, L10, L11, L12 }, \ + { L13, L14, L15, L16, L17, L18 }, \ + { L19, L20, L21, L22, L23, L24 }, \ + { M01, M02, M03, M04, M05, M06 }, \ + { M07, M08, M09, M10, M11, M12 }, \ + { M13, M14, M15, M16, M17, M18 }, \ + { M19, M20, M21, M22, M23, M24 }, \ + { R01, R02, R03, R04, R05, R06 }, \ + { R07, R08, R09, R10, R11, R12 }, \ + { R13, R14, R15, R16, R17, R18 }, \ + { R19, R20, R21, R22, R23, R24 } \ + } + +// clang-format on diff --git a/keyboards/chidori/config.h b/keyboards/chidori/config.h new file mode 100644 index 0000000000..669b68a247 --- /dev/null +++ b/keyboards/chidori/config.h @@ -0,0 +1,253 @@ +/* +Copyright 2019 ENDO Katsuhiro <ka2hiro@kagizaraya.jp> + +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/>. +*/ + +#pragma once + +#include "config_common.h" + +/* USB Device descriptor parameter */ +#define VENDOR_ID 0xFEED +#define PRODUCT_ID 0x3942 +#define DEVICE_VER 0x0001 +#define MANUFACTURER Kagizaraya +#define PRODUCT Chidori +#define DESCRIPTION Yet another split keyboard made with only through - hole components + +/* key matrix size */ +#define MATRIX_ROWS 12 +#define MATRIX_COLS 6 + +/* + * Keyboard Matrix Assignments + * + * Change this to how you wired your keyboard + * COLS: AVR pins used for columns, left to right + * ROWS: AVR pins used for rows, top to bottom + * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode) + * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode) + * + */ +/* +#define MATRIX_ROW_PINS \ + { D0, D5 } +#define MATRIX_COL_PINS \ + { F1, F0, B0 } +*/ +#define UNUSED_PINS + +/* COL2ROW, ROW2COL*/ +// #define DIODE_DIRECTION COL2ROW + +/* + * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN. + */ +// #define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6 + +// #define BACKLIGHT_PIN B7 +// #define BACKLIGHT_BREATHING +// #define BACKLIGHT_LEVELS 3 + +// #define RGB_DI_PIN E2 +// #ifdef RGB_DI_PIN +// #define RGBLED_NUM 16 +// #define RGBLIGHT_HUE_STEP 8 +// #define RGBLIGHT_SAT_STEP 8 +// #define RGBLIGHT_VAL_STEP 8 +// #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */ +// #define RGBLIGHT_SLEEP /* If defined, the RGB lighting will be switched off when the host goes to sleep */ +// /*== all animations enable ==*/ +// #define RGBLIGHT_ANIMATIONS +// /*== or choose animations ==*/ +// #define RGBLIGHT_EFFECT_BREATHING +// #define RGBLIGHT_EFFECT_RAINBOW_MOOD +// #define RGBLIGHT_EFFECT_RAINBOW_SWIRL +// #define RGBLIGHT_EFFECT_SNAKE +// #define RGBLIGHT_EFFECT_KNIGHT +// #define RGBLIGHT_EFFECT_CHRISTMAS +// #define RGBLIGHT_EFFECT_STATIC_GRADIENT +// #define RGBLIGHT_EFFECT_RGB_TEST +// #define RGBLIGHT_EFFECT_ALTERNATING +// /*== customize breathing effect ==*/ +// /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/ +// #define RGBLIGHT_BREATHE_TABLE_SIZE 256 // 256(default) or 128 or 64 +// /*==== use exp() and sin() ====*/ +// #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85 // 1 to 2.7 +// #define RGBLIGHT_EFFECT_BREATHE_MAX 255 // 0 to 255 +// #endif + +/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */ +#define DEBOUNCE 5 + +/* define if matrix has ghost (lacks anti-ghosting diodes) */ +//#define MATRIX_HAS_GHOST + +/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */ +#define LOCKING_SUPPORT_ENABLE +/* Locking resynchronize hack */ +#define LOCKING_RESYNC_ENABLE + +/* If defined, GRAVE_ESC will always act as ESC when CTRL is held. + * This is userful for the Windows task manager shortcut (ctrl+shift+esc). + */ +// #define GRAVE_ESC_CTRL_OVERRIDE + +/* + * Force NKRO + * + * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved + * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the + * makefile for this to work.) + * + * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N) + * until the next keyboard reset. + * + * NKRO may prevent your keystrokes from being detected in the BIOS, but it is + * fully operational during normal computer usage. + * + * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N) + * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by + * bootmagic, NKRO mode will always be enabled until it is toggled again during a + * power-up. + * + */ +//#define FORCE_NKRO + +/* + * Magic Key Options + * + * Magic keys are hotkey commands that allow control over firmware functions of + * the keyboard. They are best used in combination with the HID Listen program, + * found here: https://www.pjrc.com/teensy/hid_listen.html + * + * The options below allow the magic key functionality to be changed. This is + * useful if your keyboard/keypad is missing keys and you want magic key support. + * + */ + +/* key combination for magic key command */ +/* defined by default; to change, uncomment and set to the combination you want */ +#define IS_COMMAND() (get_mods() == (MOD_BIT(KC_LSFT) | MOD_BIT(KC_LCTL))) + +/* control how magic key switches layers */ +//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true +//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true +//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false + +/* override magic key keymap */ +//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS +//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS +//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM +//#define MAGIC_KEY_HELP H +//#define MAGIC_KEY_HELP_ALT SLASH +//#define MAGIC_KEY_DEBUG D +//#define MAGIC_KEY_DEBUG_MATRIX X +//#define MAGIC_KEY_DEBUG_KBD K +//#define MAGIC_KEY_DEBUG_MOUSE M +//#define MAGIC_KEY_VERSION V +//#define MAGIC_KEY_STATUS S +//#define MAGIC_KEY_CONSOLE C +//#define MAGIC_KEY_LAYER0 0 +//#define MAGIC_KEY_LAYER0_ALT GRAVE +//#define MAGIC_KEY_LAYER1 1 +//#define MAGIC_KEY_LAYER2 2 +//#define MAGIC_KEY_LAYER3 3 +//#define MAGIC_KEY_LAYER4 4 +//#define MAGIC_KEY_LAYER5 5 +//#define MAGIC_KEY_LAYER6 6 +//#define MAGIC_KEY_LAYER7 7 +//#define MAGIC_KEY_LAYER8 8 +//#define MAGIC_KEY_LAYER9 9 +//#define MAGIC_KEY_BOOTLOADER B +//#define MAGIC_KEY_BOOTLOADER_ALT ESC +//#define MAGIC_KEY_LOCK CAPS +//#define MAGIC_KEY_EEPROM E +//#define MAGIC_KEY_EEPROM_CLEAR BSPACE +//#define MAGIC_KEY_NKRO N +//#define MAGIC_KEY_SLEEP_LED Z + +/* + * Feature disable options + * These options are also useful to firmware size reduction. + */ + +/* disable debug print */ +//#define NO_DEBUG + +/* disable print */ +//#define NO_PRINT + +/* disable action features */ +//#define NO_ACTION_LAYER +//#define NO_ACTION_TAPPING +//#define NO_ACTION_ONESHOT +//#define NO_ACTION_MACRO +//#define NO_ACTION_FUNCTION + +/* + * MIDI options + */ + +/* Prevent use of disabled MIDI features in the keymap */ +//#define MIDI_ENABLE_STRICT 1 + +/* enable basic MIDI features: + - MIDI notes can be sent when in Music mode is on +*/ +//#define MIDI_BASIC + +/* enable advanced MIDI features: + - MIDI notes can be added to the keymap + - Octave shift and transpose + - Virtual sustain, portamento, and modulation wheel + - etc. +*/ +//#define MIDI_ADVANCED + +/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */ +//#define MIDI_TONE_KEYCODE_OCTAVES 1 + +/* + * HD44780 LCD Display Configuration + */ +/* +#define LCD_LINES 2 //< number of visible lines of the display +#define LCD_DISP_LENGTH 16 //< visibles characters per line of the display + +#define LCD_IO_MODE 1 //< 0: memory mapped mode, 1: IO port mode + +#if LCD_IO_MODE +#define LCD_PORT PORTB //< port for the LCD lines +#define LCD_DATA0_PORT LCD_PORT //< port for 4bit data bit 0 +#define LCD_DATA1_PORT LCD_PORT //< port for 4bit data bit 1 +#define LCD_DATA2_PORT LCD_PORT //< port for 4bit data bit 2 +#define LCD_DATA3_PORT LCD_PORT //< port for 4bit data bit 3 +#define LCD_DATA0_PIN 4 //< pin for 4bit data bit 0 +#define LCD_DATA1_PIN 5 |