Skip to content

Commit

Permalink
[Keyboard] Add Keychron Q11 (#20125)
Browse files Browse the repository at this point in the history
Co-authored-by: Drashna Jaelre <[email protected]>
Co-authored-by: adophoxia <[email protected]>
Co-authored-by: Ryan <[email protected]>
  • Loading branch information
4 people authored Apr 6, 2023
1 parent eab2b8f commit 655c24d
Show file tree
Hide file tree
Showing 15 changed files with 958 additions and 0 deletions.
244 changes: 244 additions & 0 deletions keyboards/keychron/q11/ansi_encoder/ansi_encoder.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,244 @@
/* Copyright 2023 @ 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 "quantum.h"

#ifdef RGB_MATRIX_ENABLE

// clang-format off

const ckled2001_led PROGMEM g_ckled2001_leds[RGB_MATRIX_LED_COUNT] = {
/* Refer to IS31 manual for these locations
* driver
* | R location
* | | G location
* | | | B location
* | | | | */
{0, A_2, C_2, B_2}, // ESC
{0, A_3, C_3, B_3}, // F1
{0, A_4, C_4, B_4}, // F2
{0, A_5, C_5, B_5}, // F3
{0, A_6, C_6, B_6}, // F4
{0, A_7, C_7, B_7}, // F5
{0, A_8, C_8, B_8}, // F6

{0, D_1, F_1, E_1}, // M1
{0, D_2, F_2, E_2}, // `~
{0, D_3, F_3, E_3}, // 1!
{0, D_4, F_4, E_4}, // 2@
{0, D_5, F_5, E_5}, // 3#
{0, D_6, F_6, E_6}, // 4$
{0, D_7, F_7, E_7}, // 5%
{0, D_8, F_8, E_8}, // 6^

{0, G_1, I_1, H_1}, // M2
{0, G_2, I_2, H_2}, // TAB
{0, G_3, I_3, H_3}, // Q
{0, G_4, I_4, H_4}, // W
{0, G_5, I_5, H_5}, // E
{0, G_6, I_6, H_6}, // R
{0, G_7, I_7, H_7}, // T

{0, J_1, L_1, K_1}, // M3
{0, J_2, L_2, K_2}, // CapsJock
{0, J_3, L_3, K_3}, // A
{0, J_4, L_4, K_4}, // S
{0, J_5, L_5, K_5}, // D
{0, J_6, L_6, K_6}, // F
{0, J_7, L_7, K_7}, // G

{0, J_9, L_9, K_9}, // M4
{0, J_11, L_11, K_11}, // Shift_J
{0, J_12, L_12, K_12}, // Z
{0, J_13, L_13, K_13}, // X
{0, J_14, L_14, K_14}, // C
{0, J_15, L_15, K_15}, // V
{0, J_16, L_16, K_16}, // B

{0, G_9, I_9, H_9}, // M5
{0, G_10, I_10, H_10}, // Ctrl_L
{0, G_11, I_11, H_11}, // WGn_L
{0, G_12, I_12, H_12}, // Alt_L
{0, G_13, I_13, H_13}, // Fn
{0, G_15, I_15, H_15}, // Space

{0, A_16, C_16, B_16}, // F7
{0, A_15, C_15, B_15}, // F8
{0, A_14, C_14, B_14}, // F9
{0, A_13, C_13, B_13}, // F11
{0, A_12, C_12, B_12}, // F11
{0, A_11, C_11, B_11}, // F12
{0, A_10, C_10, B_10}, // INS
{0, A_9, C_9, B_9}, // DEL

{0, D_16, F_16, E_16}, // 7&
{0, D_15, F_15, E_15}, // 8*
{0, D_14, F_14, E_14}, // 9(
{0, D_13, F_13, E_13}, // 1)
{0, D_12, F_12, E_12}, // -_
{0, D_11, F_11, E_11}, // =+
{0, D_10, F_10, E_10}, // BackSpace
{0, D_8, F_8, E_8}, // PgUp

{0, G_16, I_16, H_16}, // Y
{0, G_15, I_15, H_15}, // U
{0, G_14, I_14, H_14}, // G
{0, G_13, I_13, H_13}, // O
{0, G_12, I_12, H_12}, // P
{0, G_11, I_11, H_11}, // [
{0, G_10, I_10, H_10}, // ]
{0, G_9, I_9, H_9}, // \||
{0, G_8, I_8, H_8}, // PgDn

{0, J_16, L_16, K_16}, // H
{0, J_15, L_15, K_15}, // J
{0, J_14, L_14, K_14}, // KKEY_PRESS_HOME
{0, J_13, L_13, K_13}, // J
{0, J_12, L_12, K_12}, // ;:
{0, J_11, L_11, K_11}, // '"
{0, J_9, L_9, K_9}, // Enter
{0, J_8, L_8, K_8}, // Home

{0, J_7, L_7, K_7}, // N
{0, J_6, L_6, K_6}, // M
{0, J_5, L_5, K_5}, // ,<
{0, J_4, L_4, K_4}, // .>
{0, J_3, L_3, K_3}, // ?/
{0, J_2, L_2, K_2}, // Shift_R
{0, J_1, L_1, K_1}, // Up

{0, G_6, I_6, H_6}, // Space
{0, G_5, I_5, H_5}, // Win_R
{0, G_4, I_4, H_4}, // Fn
{0, G_3, I_3, H_3}, // Ctrl_R
{0, G_2, I_2, H_2}, // Left
{0, G_1, I_1, H_1}, // Down
{0, G_7, I_7, H_7}, // Right
};

#define __ NO_LED

led_config_t g_led_config = {
{
// Key Matrix to LED Index
{ __, 0, 1, 2, 3, 4, 5, 6, __ },
{ 7, 8, 9, 10, 11, 12, 13, 14, __ },
{ 15, 16, 17, 18, 19, __, 20, 21, __ },
{ 22, 23, 24, 25, 26, 27, 28, __, __ },
{ 29, __, 30, 31, 32, 33, 34, 35, __ },
{ 36, 37, 38, 39, 40, __, 41, __, __ },
{ 42, 43, 44, 45, 46, 47, 48, 49, __ },
{ 50, 51, 52, 53, 54, 55, 56, __, 57 },
{ 58, 59, 60, 61, 62, 63, 64, 65, 66 },
{ 67, 68, 69, 70, 71, 72, __, 73, 74 },
{ 75, 76, 77, 78, 79, 80, __, 81, __ },
{ __, 82, 83, 84, 85, __, 86, 87, 88 },
},
{
// LED Index to Physical Position
{17,0}, {31,0}, {45,0}, {59,0}, {72,0}, {86,0}, {100,0},
{0,15}, {17,15}, {31,15}, {45,15}, {59,15}, {72,15}, {86,15}, {100,15},
{0,27}, {21,27}, {38,27}, {52,27}, {66,27}, {79,27}, {93,27},
{0,40}, {22,40}, {41,40}, {55,40}, {69,40}, {83,40}, {97,40},
{0,52}, {26,52}, {48,52}, {61,52}, {76,52}, {90,52}, {102,52},
{0,64}, {19,64}, {36,64}, {53,64}, {70,64}, {94,64},
{110,0}, {124,0}, {138,0}, {152,0}, {165,0}, {179,0}, {193,0}, {207,0},
{110,15}, {124,15}, {138,15}, {152,15}, {165,15}, {179,15}, {200,15}, {224,15},
{104,27}, {117,27}, {131,27}, {145,27}, {158,27}, {172,27}, {186,27}, {203,27}, {224,27},
{107,40}, {121,40}, {134,40}, {148,40}, {162,40}, {176,40}, {198,40}, {224,40},
{114,52}, {127,52}, {141,52}, {155,52}, {169,52}, {188,52}, {210,52},
{126,64}, {152,64}, {166,64}, {180,64}, {196,64}, {210,64}, {224,64},
},
{
// RGB LED Index to Flag
1, 1, 1, 1, 1, 1, 1,
1, 1, 4, 4, 4, 4, 4, 4,
1, 1, 4, 4, 4, 4, 4,
1, 8, 4, 4, 4, 4, 4,
1, 1, 4, 4, 4, 4, 4,
1, 1, 1, 1, 1, 4,
1, 1, 1, 1, 1, 1, 1, 1,
4, 4, 4, 4, 4, 4, 1, 1,
4, 4, 4, 4, 4, 4, 4, 4, 1,
4, 4, 4, 4, 4, 4, 1, 1,
4, 4, 4, 4, 4, 1, 1,
4, 1, 1, 1, 1, 1, 1,
}
};

// clang-format on

#endif

#define ADC_BUFFER_DEPTH 1
#define ADC_NUM_CHANNELS 1
#define ADC_SAMPLING_RATE ADC_SMPR_SMP_12P5
#define ADC_RESOLUTION ADC_CFGR_RES_10BITS

static int16_t analogReadPin_my(pin_t pin) {
ADCConfig adcCfg = {};
adcsample_t sampleBuffer[ADC_NUM_CHANNELS*ADC_BUFFER_DEPTH];
ADCDriver* targetDriver = &ADCD1;
ADCConversionGroup adcConversionGroup = {
.circular = FALSE,
.num_channels = (uint16_t)(ADC_NUM_CHANNELS),
.cfgr = ADC_RESOLUTION,
};

palSetLineMode(pin, PAL_MODE_INPUT_ANALOG);
switch (pin) {
case B0:
adcConversionGroup.smpr[2] = ADC_SMPR2_SMP_AN15(ADC_SAMPLING_RATE);
adcConversionGroup.sqr[0] = ADC_SQR1_SQ1_N(ADC_CHANNEL_IN15);
sampleBuffer[0] = 0;
break;
case B1:
adcConversionGroup.smpr[2] = ADC_SMPR2_SMP_AN16(ADC_SAMPLING_RATE);
adcConversionGroup.sqr[0] = ADC_SQR1_SQ1_N(ADC_CHANNEL_IN16);
sampleBuffer[0] = 0;
break;
default:
return 0;
}
adcStart(targetDriver, &adcCfg);
if (adcConvert(targetDriver, &adcConversionGroup, &sampleBuffer[0], ADC_BUFFER_DEPTH) != MSG_OK) {
return 0;
}

return *sampleBuffer;
}

void keyboard_post_init_kb(void) {
// 1. The pin A5/B5 of the USB C interface in the left hand is connected to the pin A0 of MCU,
// A0 will be set to output and write high when keyboard initial.
// 2. The same pin in the right hand is connected to the pin B0 and B1 of MCU respectively,
// and the ADC function of B0 and B1 will be enabled when keyboard initial.
// 3. because the serial usart RXD and TXD is multiplexed on USB's D+ and D- in the right hand.
// So detect the voltage on the pin A5/B5 of the USB C interface by ADC,
// and disable USB connectivity when the ADC value exceeds 1000,
// to avoid affecting the serial usart communication between the left hand and the right hand.
if (is_keyboard_left()) {
setPinOutput(A0);
writePinHigh(A0);
} else {
if ((analogReadPin_my(B0) > 1000) || (analogReadPin_my(B1) > 1000)) {
setPinInput(A11);
setPinInput(A12);
}
}

keyboard_post_init_user();
}
20 changes: 20 additions & 0 deletions keyboards/keychron/q11/ansi_encoder/config.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/* Copyright 2023 @ 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

/* Enable caps-lock LED */
#define CAPS_LOCK_LED_INDEX 23
Loading

0 comments on commit 655c24d

Please sign in to comment.