Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Keychron q6 #18288

Merged
merged 40 commits into from
Nov 13, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
34b97f2
Add q6 for keychron
galican Sep 6, 2022
7e4d715
Update q6
galican Sep 6, 2022
1ba1bba
Update readme.md of q6
galican Sep 6, 2022
b15df5e
Upate mcuconf.h
galican Sep 6, 2022
8cc80bc
Update keyboards/keychron/q6/q6.c
KeychronMacro Sep 15, 2022
1c4df66
Update q6
galican Sep 15, 2022
2e21972
Merge branch 'keychron-q6' of https://github.com/Keychron/qmk_firmwar…
galican Sep 15, 2022
80102f8
Move matrix definitions into info.json
galican Sep 23, 2022
c3c7785
Merge branch 'temp' into keychron-q6
KeychronMacro Oct 13, 2022
cc7d5c9
Partial cleanup of Q6
KeychronMacro Oct 13, 2022
d451b42
Update q6.c
KeychronMacro Oct 25, 2022
c716aa8
Update keyboards/keychron/q6/ansi/keymaps/default/keymap.c
KeychronMacro Nov 12, 2022
59c12f8
Update keyboards/keychron/q6/ansi/keymaps/via/keymap.c
KeychronMacro Nov 12, 2022
0e994c0
Update keyboards/keychron/q6/ansi/keymaps/keychron/keymap.c
KeychronMacro Nov 12, 2022
420b68a
Update keyboards/keychron/q6/ansi/keymaps/default/keymap.c
KeychronMacro Nov 12, 2022
7facfe9
Update keyboards/keychron/q6/ansi/keymaps/keychron/keymap.c
KeychronMacro Nov 12, 2022
3b8ea18
Update keyboards/keychron/q6/ansi/keymaps/via/keymap.c
KeychronMacro Nov 12, 2022
5502e51
Update keyboards/keychron/q6/iso_encoder/keymaps/keychron/keymap.c
KeychronMacro Nov 12, 2022
daed868
Update keyboards/keychron/q6/ansi_encoder/keymaps/default/keymap.c
KeychronMacro Nov 12, 2022
0520129
Update keyboards/keychron/q6/iso_encoder/keymaps/via/keymap.c
KeychronMacro Nov 12, 2022
0eec72f
Update keyboards/keychron/q6/iso_encoder/keymaps/keychron/keymap.c
KeychronMacro Nov 12, 2022
c1cf59b
Update keyboards/keychron/q6/iso_encoder/rules.mk
KeychronMacro Nov 12, 2022
a48b56e
Update keyboards/keychron/q6/iso_encoder/keymaps/via/keymap.c
KeychronMacro Nov 12, 2022
999b96d
Update keyboards/keychron/q6/ansi_encoder/keymaps/default/keymap.c
KeychronMacro Nov 12, 2022
a44aa7e
Update keyboards/keychron/q6/readme.md
KeychronMacro Nov 12, 2022
962f92b
Update keyboards/keychron/q6/ansi_encoder/keymaps/keychron/keymap.c
KeychronMacro Nov 12, 2022
c713aa0
Update keyboards/keychron/q6/ansi_encoder/keymaps/keychron/keymap.c
KeychronMacro Nov 12, 2022
698d788
Update keyboards/keychron/q6/ansi_encoder/keymaps/via/keymap.c
KeychronMacro Nov 12, 2022
92e4d0c
Update keyboards/keychron/q6/ansi_encoder/keymaps/via/keymap.c
KeychronMacro Nov 12, 2022
b3a71d9
Update keyboards/keychron/q6/ansi_encoder/rules.mk
KeychronMacro Nov 12, 2022
44a557c
Update keyboards/keychron/q6/ansi/rules.mk
KeychronMacro Nov 12, 2022
759a953
Update keyboards/keychron/q6/iso/keymaps/default/keymap.c
KeychronMacro Nov 12, 2022
a16a718
Update keyboards/keychron/q6/iso_encoder/keymaps/default/keymap.c
KeychronMacro Nov 12, 2022
e8f3887
Update keyboards/keychron/q6/iso/keymaps/default/keymap.c
KeychronMacro Nov 12, 2022
1bb59a2
Update keyboards/keychron/q6/iso/keymaps/keychron/keymap.c
KeychronMacro Nov 12, 2022
1e2582a
Update keyboards/keychron/q6/iso/keymaps/keychron/keymap.c
KeychronMacro Nov 12, 2022
c372677
Update keyboards/keychron/q6/iso/keymaps/via/keymap.c
KeychronMacro Nov 12, 2022
0c45062
Update keyboards/keychron/q6/iso_encoder/keymaps/default/keymap.c
KeychronMacro Nov 12, 2022
a872548
Update keyboards/keychron/q6/iso/keymaps/via/keymap.c
KeychronMacro Nov 12, 2022
c7dc139
Update keyboards/keychron/q6/iso/rules.mk
KeychronMacro Nov 12, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions keyboards/keychron/q6/config.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
/* Copyright 2022 @ Keychron(https://www.keychron.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/>.
*/

#pragma once

/* Key matrix size */
#define MATRIX_ROWS 6
#define MATRIX_COLS 20

/* COL2ROW or ROW2COL */
#define DIODE_DIRECTION ROW2COL

/* Set 0 if debouncing isn't needed */
#define DEBOUNCE 5

/* RGB Matrix Driver Configuration */
#define DRIVER_COUNT 2
#define DRIVER_ADDR_1 0b1110111
#define DRIVER_ADDR_2 0b1110100

#define CKLED2001_CURRENT_TUNE \
{ 0xA4, 0xA4, 0x52, 0xA4, 0xA4, 0x52, 0xA4, 0xA4, 0x52, 0xA4, 0xA4, 0x52 }

/* DIP switch */
#define DIP_SWITCH_MATRIX_GRID { {5, 4} }

/* Disable DIP switch in matrix data */
#define MATRIX_MASKED

/* turn off effects when suspended */
#define RGB_DISABLE_WHEN_USB_SUSPENDED

/* EEPROM Driver Configuration */
#define WEAR_LEVELING_LOGICAL_SIZE 2048
#define WEAR_LEVELING_BACKING_SIZE (WEAR_LEVELING_LOGICAL_SIZE * 2)

// RGB Matrix Animation modes. Explicitly enabled
// For full list of effects, see:
// https://docs.qmk.fm/#/feature_rgb_matrix?id=rgb-matrix-effects
// #define ENABLE_RGB_MATRIX_ALPHAS_MODS
// #define ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN
// #define ENABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT
#define ENABLE_RGB_MATRIX_BREATHING
// #define ENABLE_RGB_MATRIX_BAND_SAT
// #define ENABLE_RGB_MATRIX_BAND_VAL
// #define ENABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
// #define ENABLE_RGB_MATRIX_BAND_PINWHEEL_VAL
// #define ENABLE_RGB_MATRIX_BAND_SPIRAL_SAT
// #define ENABLE_RGB_MATRIX_BAND_SPIRAL_VAL
#define ENABLE_RGB_MATRIX_CYCLE_ALL
#define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
#define ENABLE_RGB_MATRIX_CYCLE_UP_DOWN
#define ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
#define ENABLE_RGB_MATRIX_CYCLE_OUT_IN
#define ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
#define ENABLE_RGB_MATRIX_CYCLE_PINWHEEL
#define ENABLE_RGB_MATRIX_CYCLE_SPIRAL
#define ENABLE_RGB_MATRIX_DUAL_BEACON
#define ENABLE_RGB_MATRIX_RAINBOW_BEACON
// #define ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS
#define ENABLE_RGB_MATRIX_RAINDROPS
// #define ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
// #define ENABLE_RGB_MATRIX_HUE_BREATHING
// #define ENABLE_RGB_MATRIX_HUE_PENDULUM
// #define ENABLE_RGB_MATRIX_HUE_WAVE
// #define ENABLE_RGB_MATRIX_PIXEL_RAIN
// #define ENABLE_RGB_MATRIX_PIXEL_FLOW
// #define ENABLE_RGB_MATRIX_PIXEL_FRACTAL
// enabled only if RGB_MATRIX_FRAMEBUFFER_EFFECTS is defined
#define ENABLE_RGB_MATRIX_TYPING_HEATMAP
#define ENABLE_RGB_MATRIX_DIGITAL_RAIN
// enabled only of RGB_MATRIX_KEYPRESSES or RGB_MATRIX_KEYRELEASES is defined
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
#define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
#define ENABLE_RGB_MATRIX_SPLASH
#define ENABLE_RGB_MATRIX_MULTISPLASH
#define ENABLE_RGB_MATRIX_SOLID_SPLASH
#define ENABLE_RGB_MATRIX_SOLID_MULTISPLASH
// #define RGB_MATRIX_KEYPRESSES
21 changes: 21 additions & 0 deletions keyboards/keychron/q6/halconf.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
/* Copyright 2020 QMK
*
* 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 HAL_USE_I2C TRUE

#include_next <halconf.h>
186 changes: 186 additions & 0 deletions keyboards/keychron/q6/matrix.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
/* Copyright 2022 @ Keychron (https://www.keychron.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 "quantum.h"

// Pin connected to DS of 74HC595
#define DATA_PIN C15
// Pin connected to SH_CP of 74HC595
#define CLOCK_PIN A1
// Pin connected to ST_CP of 74HC595
#define LATCH_PIN A0

#ifdef MATRIX_ROW_PINS
static pin_t row_pins[MATRIX_ROWS] = MATRIX_ROW_PINS;
#endif // MATRIX_ROW_PINS
#ifdef MATRIX_COL_PINS
static pin_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
#endif // MATRIX_COL_PINS

#define ROWS_PER_HAND (MATRIX_ROWS)

#ifndef NO_PIN_NUM
# define NO_PIN_NUM 8
#endif

#ifndef COL_OFFSET
# define COL_OFFSET 0
#endif

#ifndef CLR_VAL
# define CLR_VAL 0xFF
#endif

static inline void setPinOutput_writeLow(pin_t pin) {
ATOMIC_BLOCK_FORCEON {
setPinOutput(pin);
writePinLow(pin);
}
}

static inline void setPinOutput_writeHigh(pin_t pin) {
ATOMIC_BLOCK_FORCEON {
setPinOutput(pin);
writePinHigh(pin);
}
}

static inline void setPinInputHigh_atomic(pin_t pin) {
ATOMIC_BLOCK_FORCEON {
setPinInputHigh(pin);
}
}

static inline uint8_t readMatrixPin(pin_t pin) {
if (pin != NO_PIN) {
return readPin(pin);
} else {
return 1;
}
}

static void shiftOut(uint16_t dataOut) {
for (uint8_t i = 0; i < NO_PIN_NUM; i++) {
if (dataOut & 0x1) {
setPinOutput_writeHigh(DATA_PIN);
} else {
setPinOutput_writeLow(DATA_PIN);
}
dataOut = dataOut >> 1;
setPinOutput_writeHigh(CLOCK_PIN);
setPinOutput_writeLow(CLOCK_PIN);
}
setPinOutput_writeHigh(LATCH_PIN);
setPinOutput_writeLow(LATCH_PIN);
}

static bool select_col(uint8_t col) {
pin_t pin = col_pins[col];

if (pin == NO_PIN) {
shiftOut(~(0x1 << ((MATRIX_COLS - COL_OFFSET) - col - 1)));
return true;
} else {
setPinOutput_writeLow(pin);
return true;
}
return false;
}

static void unselect_col(uint8_t col) {
pin_t pin = col_pins[col];

if (pin == NO_PIN) {
shiftOut(CLR_VAL);
} else {
setPinInputHigh_atomic(pin);
}
}

static void unselect_col_my(uint8_t col) {
pin_t pin = col_pins[col];

if (pin == NO_PIN) {
if (col == (MATRIX_COLS - COL_OFFSET - 1)) {
shiftOut(CLR_VAL);
}
} else {
setPinInputHigh_atomic(pin);
}
}

static void unselect_cols(void) {
for (uint8_t x = 0; x < MATRIX_COLS; x++) {
unselect_col_my(x);
}
}

static void matrix_init_pins(void) {
unselect_cols();
for (uint8_t x = 0; x < MATRIX_ROWS; x++) {
if (row_pins[x] != NO_PIN) {
setPinInputHigh_atomic(row_pins[x]);
}
}
}

static void matrix_read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col, matrix_row_t row_shifter) {
bool key_pressed = false;

// Select col
if (!select_col(current_col)) { // select col
return; // skip NO_PIN col
}
matrix_output_select_delay();

// For each row...
for (uint8_t row_index = 0; row_index < ROWS_PER_HAND; row_index++) {
// Check row pin state
if (readMatrixPin(row_pins[row_index]) == 0) {
// Pin LO, set col bit
current_matrix[row_index] |= row_shifter;
key_pressed = true;
} else {
// Pin HI, clear col bit
current_matrix[row_index] &= ~row_shifter;
}
}

// Unselect col
unselect_col(current_col);
matrix_output_unselect_delay(current_col, key_pressed); // wait for all Row signals to go HIGH
}

void matrix_init_custom(void) {
// initialize key pins
matrix_init_pins();
}

bool matrix_scan_custom(matrix_row_t current_matrix[]) {
matrix_row_t curr_matrix[MATRIX_ROWS] = {0};

// Set col, read rows
matrix_row_t row_shifter = MATRIX_ROW_SHIFTER;
for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++, row_shifter <<= 1) {
matrix_read_rows_on_col(curr_matrix, current_col, row_shifter);
}

bool changed = memcmp(current_matrix, curr_matrix, sizeof(curr_matrix)) != 0;
if (changed) memcpy(current_matrix, curr_matrix, sizeof(curr_matrix));

return changed;
}
22 changes: 22 additions & 0 deletions keyboards/keychron/q6/mcuconf.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/* Copyright 2020 QMK
*
* 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_next <mcuconf.h>

#undef STM32_I2C_USE_I2C1
#define STM32_I2C_USE_I2C1 TRUE
Loading