Skip to content

Commit 5b644af

Browse files
drashnafauxpark
drashna
and
fauxpark
authored
[Keyboard] Enable Proton C defaults for SplitKB Kyria (#14490)
Co-authored-by: Ryan <[email protected]>
1 parent 4811040 commit 5b644af

File tree

10 files changed

+162
-12
lines changed

10 files changed

+162
-12
lines changed

‎keyboards/splitkb/kyria/keymaps/drashna/rules.mk

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ COMMAND_ENABLE = no # Commands for debug and configuration
1212
NKRO_ENABLE = yes # USB Nkey Rollover
1313
UNICODE_ENABLE = no # Unicode
1414
KEY_LOCK_ENABLE = no
15+
CTPC = yes
1516

16-
17-
BOOTLOADER = hid
18-
BOOTLOADER_SIZE = 512
19-
PROGRAM_CMD = $(HID_BOOTLOADER_CLI) -mmcu=$(MCU) -w -v $(BUILD_DIR)/$(TARGET).hex
17+
# BOOTLOADER = hid
18+
# BOOTLOADER_SIZE = 512
19+
# PROGRAM_CMD = $(HID_BOOTLOADER_CLI) -mmcu=$(MCU) -w -v $(BUILD_DIR)/$(TARGET).hex
2020
# TAP_DANCE_ENABLE = yes
2121

2222
WPM_ENABLE = yes

‎keyboards/splitkb/kyria/readme.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ Hardware Availability: [splitkb.com](https://splitkb.com) and partners.
1010

1111
Make example for this keyboard (after setting up your build environment):
1212

13-
make splitkb/kyria:default
13+
make splitkb/kyria/rev1:default
14+
make splitkb/kyria/rev1/proton_c:default
1415

1516
Example of flashing this keyboard:
1617

@@ -19,3 +20,22 @@ Example of flashing this keyboard:
1920
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).
2021

2122
A build guide for the Kyria can be found at [docs.splitkb.com](https://docs.splitkb.com/hc/en-us/articles/360010552059-Kyria-Build-Guide-Introduction).
23+
24+
## Proton C Conversion Guide
25+
26+
If you're one of the lucky people to have Proton Cs to use with their Kyria, there are a couple of caveats to getting this working.
27+
28+
1. You need to have 2x Proton Cs, as you cannot mix and match with Pro Micros or Elite C's. They both need to be Proton Cs.
29+
2. You'll need to do some modding to enable proper support with the Proton C.
30+
31+
By design, the Kyria uses every available pin on the Pro Micro footprint. This includes using D3 (RX) for RGB. This poses a challenge with using the Proton C, since it needs both the TX and RX pins. The Proton C needs both pins, especially if you plan on using Full Duplex Serial.
32+
33+
To fix this, you need to break off the last header position on the right-hand side on the footprint. This is the `TX0/D3` pad. Leave this pad without a header connected to.
34+
35+
From the A9 pin on the Proton C, you want to run a wire from it to the `SDA + Extra Data` pad near the TRRS jack on the PCB. This will allow for proper, full duplex communication over the TRRS cable.
36+
37+
To get RGB working properly, as well, you want to run a wire from the `A3` pin on the Proton C, next to the GND and DFU pin, right under the USB port. Run this to the `TX0/D3` pad (the one you left without a header pin on the PCB).
38+
39+
Once you've done that, you can solder in the Proton C. and flash it.
40+
41+
![Proton C](https://i.imgur.com/nICqWLo.jpg)

‎keyboards/splitkb/kyria/rev1/config.h

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,18 +57,31 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
5757
/*
5858
* Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
5959
*/
60-
#define SOFT_SERIAL_PIN D2
6160

62-
#define RGB_DI_PIN D3
61+
#if defined(CONVERT_TO_PROTON_C)
62+
# define SERIAL_USART_FULL_DUPLEX // Enable full duplex operation mode.
63+
# define SERIAL_USART_PIN_SWAP // Swap TX and RX pins if keyboard is master halve.
64+
# define SERIAL_USART_DRIVER SD1 // USART driver of TX pin. default: SD1
65+
# define SERIAL_USART_TX_PAL_MODE 7 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 7
66+
# define SERIAL_USART_TX_PIN D3
67+
# define SERIAL_USART_RX_PIN D2
68+
69+
# define RGB_DI_PIN PAL_LINE(GPIOA, 3)
70+
# define WS2812_PWM_DRIVER PWMD2 // default: PWMD2
71+
# define WS2812_PWM_CHANNEL 4 // default: 2
72+
# define WS2812_PWM_PAL_MODE 1 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 2
73+
# define WS2812_DMA_STREAM STM32_DMA1_STREAM2 // DMA Stream for TIMx_UP, see the respective reference manual for the appropriate values for your MCU.
74+
# define WS2812_DMA_CHANNEL 2 // DMA Channel for TIMx_UP, see the respective reference manual for the appropriate values for your MCU.
75+
# define WS2812_DMAMUX_ID STM32_DMAMUX1_TIM2_UP // DMAMUX configuration for TIMx_UP -- only required if your MCU has a DMAMUX peripheral, see the respective reference manual for the appropriate values for your MCU.
76+
#else
77+
# define RGB_DI_PIN D3
78+
# define SOFT_SERIAL_PIN D2
79+
#endif
80+
6381
#define RGBLED_SPLIT \
6482
{ 10, 10 }
6583
#define RGBLED_NUM 20
6684

67-
/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
68-
#define LOCKING_SUPPORT_ENABLE
69-
/* Locking resynchronize hack */
70-
#define LOCKING_RESYNC_ENABLE
71-
7285
#ifdef OLED_ENABLE
7386
# define OLED_DISPLAY_128X64
7487
# define SPLIT_OLED_ENABLE

‎keyboards/splitkb/kyria/rev1/proton_c/chconf.h

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
/* Copyright 2020 QMK
2+
*
3+
* This program is free software: you can redistribute it and/or modify
4+
* it under the terms of the GNU General Public License as published by
5+
* the Free Software Foundation, either version 2 of the License, or
6+
* (at your option) any later version.
7+
*
8+
* This program is distributed in the hope that it will be useful,
9+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11+
* GNU General Public License for more details.
12+
*
13+
* You should have received a copy of the GNU General Public License
14+
* along with this program. If not, see <http://www.gnu.org/licenses/>.
15+
*/
16+
17+
#pragma once
18+
19+
#define CH_CFG_ST_RESOLUTION 16
20+
#define CH_CFG_ST_FREQUENCY 10000
21+
22+
#include_next "chconf.h"

‎keyboards/splitkb/kyria/rev1/proton_c/halconf.h

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
/* Copyright 2020 QMK
2+
*
3+
* This program is free software: you can redistribute it and/or modify
4+
* it under the terms of the GNU General Public License as published by
5+
* the Free Software Foundation, either version 3 of the License, or
6+
* (at your option) any later version.
7+
*
8+
* This program is distributed in the hope that it will be useful,
9+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11+
* GNU General Public License for more details.
12+
*
13+
* You should have received a copy of the GNU General Public License
14+
* along with this program. If not, see <https://www.gnu.org/licenses/>.
15+
*/
16+
#pragma once
17+
18+
#define HAL_USE_I2C TRUE
19+
#define HAL_USE_PWM TRUE
20+
#define HAL_USE_SERIAL TRUE
21+
22+
#include_next <halconf.h>

‎keyboards/splitkb/kyria/rev1/proton_c/mcuconf.h

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
/* Copyright 2020 QMK
2+
*
3+
* This program is free software: you can redistribute it and/or modify
4+
* it under the terms of the GNU General Public License as published by
5+
* the Free Software Foundation, either version 3 of the License, or
6+
* (at your option) any later version.
7+
*
8+
* This program is distributed in the hope that it will be useful,
9+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11+
* GNU General Public License for more details.
12+
*
13+
* You should have received a copy of the GNU General Public License
14+
* along with this program. If not, see <https://www.gnu.org/licenses/>.
15+
*/
16+
#pragma once
17+
18+
#include_next <mcuconf.h>
19+
20+
#undef STM32_PWM_USE_TIM2
21+
#define STM32_PWM_USE_TIM2 TRUE
22+
#undef STM32_PWM_USE_TIM3
23+
#define STM32_PWM_USE_TIM3 FALSE
24+
25+
#undef STM32_SERIAL_USE_USART1
26+
#define STM32_SERIAL_USE_USART1 TRUE
27+
28+
#undef STM32_ST_USE_TIMER
29+
#define STM32_ST_USE_TIMER 3

‎keyboards/splitkb/kyria/rev1/proton_c/proton_c.c

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
/* Copyright 2019 Thomas Baart <[email protected]>
2+
*
3+
* This program is free software: you can redistribute it and/or modify
4+
* it under the terms of the GNU General Public License as published by
5+
* the Free Software Foundation, either version 2 of the License, or
6+
* (at your option) any later version.
7+
*
8+
* This program is distributed in the hope that it will be useful,
9+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11+
* GNU General Public License for more details.
12+
*
13+
* You should have received a copy of the GNU General Public License
14+
* along with this program. If not, see <http://www.gnu.org/licenses/>.
15+
*/
16+
17+
#include "proton_c.h"

‎keyboards/splitkb/kyria/rev1/proton_c/proton_c.h

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
/* Copyright 2019 Thomas Baart <[email protected]>
2+
*
3+
* This program is free software: you can redistribute it and/or modify
4+
* it under the terms of the GNU General Public License as published by
5+
* the Free Software Foundation, either version 2 of the License, or
6+
* (at your option) any later version.
7+
*
8+
* This program is distributed in the hope that it will be useful,
9+
* but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11+
* GNU General Public License for more details.
12+
*
13+
* You should have received a copy of the GNU General Public License
14+
* along with this program. If not, see <http://www.gnu.org/licenses/>.
15+
*/
16+
17+
#pragma once
18+
19+
#include "rev1.h"

‎keyboards/splitkb/kyria/rev1/proton_c/rules.mk

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
WS2812_DRIVER = pwm
2+
SERIAL_DRIVER = usart
3+
AUDIO_ENABLE = no
4+
LTO_ENABLE = no
5+
CONVERT_TO_PROTON_C = yes

‎keyboards/splitkb/kyria/rev1/rev1.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
#pragma once
1717

1818
#include "kyria.h"
19+
#ifdef KEYBOARD_splitkb_kyria_rev1_proton_c
20+
# include "proton_c.h"
21+
#endif
1922

2023
/* This a shortcut to help you visually see your layout.
2124
*

0 commit comments

Comments
 (0)