Merge remote-tracking branch 'origin/master' into develop

keyboards/redox/readme.md

@@ -11,19 +11,38 @@
 **Redox**: the **R**educed **E**rgo**dox** project. More information and building instruction [here](https://github.com/mattdibi/redox-keyboard).
 
 - Keyboard Maintainer: [Mattia Dal Ben](https://github.com/mattdibi)  
-- Hardware Supported: Redox PCB rev1.0 w/ Pro Micro  
+- Hardware Supported: Redox PCB rev1.0 w/ Pro Micro or Proton C
 - Hardware Availability: [Falbatech](https://falba.tech/product-category/keyboard-parts/redox-parts/)
 
-Make example for this keyboard (after setting up your build environment):
+Make example for this keyboard (after setting up [qmk](https://docs.qmk.fm/#/getting_started_build_tools)):
 
+To build the Pro Micro firmware, first set your config:
 ```sh
-make redox/rev1:default
+qmk config user.keyboard=redox/rev1
+```
+or if your using the Proton C:
+```sh
+qmk config user.keyboard=redox/rev1/proton_c
+```
+
+Don't forget to set a layout. There's many to choose from in the keymaps folder.
+```sh
+qmk config user.keymap=default
 ```
 
-Example of flashing this keyboard:
+Now you can build your firmware!
+```sh
+qmk compile
+```
 
+Flashing is also straightforward. Run:
 ```sh
-make redox/rev1:default:avrdude
+qmk flash
 ```
+Enter the bootloader when prompted by doing one of the following:
+* **Physical reset button**: Briefly press the button on the back of the PCB
+* **Keycode in layout**: Press the key mapped to `RESET` if you have a layout that has one.
+
+The WS2812 driver is *untested* on the Proton C, but if you choose to use this feature, you will need to source 5v from the Proton's VUSB pin and not use the PCB's dedicated pin which will be 3v3 *and* follow the [documentation](https://docs.qmk.fm/#/ws2812_driver) to enable the correct driver settings.
 
-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).
+Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).

keyboards/redox/rev1/proton_c/config.h

@@ -0,0 +1,66 @@
+// Copyright 2022 xerootg
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#undef DEVICE_VER
+#define DEVICE_VER      0x0101 // added 1 for the rev1 + proton c
+
+// wiring of each half
+#undef MATRIX_ROW_PINS
+#define MATRIX_ROW_PINS { B5, B3, B2, B1, B0 }
+#undef MATRIX_COL_PINS
+#define MATRIX_COL_PINS { A1, A0, B8, B13, B14, B15, B9 }
+
+// //we are using hardware serial, so lets undef the softserial used otherwise
+
+/* serial.c configuration for split keyboard */
+#define SERIAL_USART_FULL_DUPLEX   // Enable full duplex operation mode.
+/* 
+   Because the rev1 config defines SOFT_SERIAL_PIN, we need to undef it, redefine it, and also assign 
+   it to avoid a redefine error.
+ */
+#undef SOFT_SERIAL_PIN
+#define SOFT_SERIAL_PIN B6     // USART TX pin
+
+#define SERIAL_USART_RX_PIN B7     // USART RX pin
+#define SERIAL_USART_TX_PIN SOFT_SERIAL_PIN     // USART TX pin
+
+#define SERIAL_USART_PIN_SWAP    // Swap TX and RX pins if keyboard is master halve.
+                                   // Check if this feature is necessary with your keyboard design and available on the mcu.
+#define SELECT_SOFT_SERIAL_SPEED 1 // or 0, 2, 3, 4, 5
+                                   //  0: 460800 baud
+                                   //  1: 230400 baud (default)
+                                   //  2: 115200 baud
+                                   //  3: 57600 baud
+                                   //  4: 38400 baud
+                                   //  5: 19200 baud
+#define SERIAL_USART_DRIVER SD1    // USART driver of TX and RX pin. default: SD1
+#define SERIAL_USART_TX_PAL_MODE 7 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 7
+#define SERIAL_USART_RX_PAL_MODE 7 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 7
+#define SERIAL_USART_TIMEOUT 20    // USART driver timeout. default 20
+
+/* ws2812 RGB LED */
+#undef RGB_DI_PIN
+#define RGB_DI_PIN A9
+
+/*
+ * 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

keyboards/redox/rev1/proton_c/halconf.h

@@ -0,0 +1,8 @@
+// Copyright 2022 xerootg
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#define HAL_USE_SERIAL TRUE
+
+#include_next <halconf.h>

keyboards/redox/rev1/proton_c/mcuconf.h

@@ -0,0 +1,9 @@
+// Copyright 2022 xerootg
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include_next <mcuconf.h>
+
+#undef STM32_SERIAL_USE_USART1
+#define STM32_SERIAL_USE_USART1 TRUE

keyboards/redox/rev1/proton_c/proton_c.c

@@ -0,0 +1,4 @@
+// Copyright 2022 xerootg
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include "proton_c.h"

keyboards/redox/rev1/proton_c/proton_c.h

@@ -0,0 +1,6 @@
+// Copyright 2022 xerootg
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include "rev1.h"

keyboards/redox/rev1/proton_c/rules.mk

@@ -0,0 +1,7 @@
+# Proton C
+MCU = STM32F303
+BOARD = QMK_PROTON_C
+BOOTLOADER = stm32-dfu
+
+# specific to using the serial serial driver
+SERIAL_DRIVER = usart

keyboards/redox/rev1/rev1.h

@@ -1,9 +1,12 @@
 #pragma once
 
-#include "../redox.h"
+#include "redox.h"
 
-#include "quantum.h"
+#if defined(KEYBOARD_redox_rev1_proton_c)
+#    include "proton_c.h"
+#endif
 
+#include "quantum.h"
 
 #ifdef USE_I2C
 #include <stddef.h>