summaryrefslogtreecommitdiff
path: root/keyboards/custommk
diff options
context:
space:
mode:
authorDavid Hoelscher <infinityis@users.noreply.github.com>2022-11-13 17:59:01 -0600
committerGitHub <noreply@github.com>2022-11-13 23:59:01 +0000
commita42ab90220ce01c2aebdebb09aa458f383d26892 (patch)
tree4920acd95eef0a390a3a7f1a182b92803bbe91df /keyboards/custommk
parent7901ba431a4a6248aeb4b16c570e96ce44e56a42 (diff)
Add Bonsai C4 as a platform board file (#18901)
* Set up Bonsai C4 as a platform board file * corrections and improvements based on testing and feedback * Added VBUS sensing as default capability for improved split support using Bonsai C4 * Update clock divisor for SPI flash Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Nick Brassel <nick@tzarc.org>
Diffstat (limited to 'keyboards/custommk')
-rw-r--r--keyboards/custommk/bonsai_c4_template/bonsai_c4_template.c23
-rw-r--r--keyboards/custommk/bonsai_c4_template/config.h79
-rw-r--r--keyboards/custommk/bonsai_c4_template/halconf.h35
-rw-r--r--keyboards/custommk/bonsai_c4_template/mcuconf.h35
-rw-r--r--keyboards/custommk/bonsai_c4_template/readme.md10
5 files changed, 0 insertions, 182 deletions
diff --git a/keyboards/custommk/bonsai_c4_template/bonsai_c4_template.c b/keyboards/custommk/bonsai_c4_template/bonsai_c4_template.c
deleted file mode 100644
index 2129a712cf..0000000000
--- a/keyboards/custommk/bonsai_c4_template/bonsai_c4_template.c
+++ /dev/null
@@ -1,23 +0,0 @@
-/* Copyright 2022 customMK
- *
- * 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/>.
- */
-
-// Set up SPI slave select pin
-void keyboard_post_init_kb(void) {
- #ifdef EXTERNAL_FLASH_SPI_SLAVE_SELECT_PIN
- setPinOutput(EXTERNAL_FLASH_SPI_SLAVE_SELECT_PIN);
- writePinHigh(EXTERNAL_FLASH_SPI_SLAVE_SELECT_PIN);
- #endif
-}
diff --git a/keyboards/custommk/bonsai_c4_template/config.h b/keyboards/custommk/bonsai_c4_template/config.h
deleted file mode 100644
index 192e9b0755..0000000000
--- a/keyboards/custommk/bonsai_c4_template/config.h
+++ /dev/null
@@ -1,79 +0,0 @@
-/* Copyright 2022 customMK
- *
- * 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"
-
-// This file includes example #defines to enable commonly-used functionality
-// (SPI, PWM backlight, etc.) on specific pins. Capabilities you want to include
-// should be added to the config.h for your keyboard. Not all capabilities are
-// shown; for example:
-// I2C is not shown because the QMK defaults are sufficient for SCL on B6 and SDA on B7
-// Serial communications (for split keyboards) is not shown because QMK defaults work
-// for either pins A15 or B6
-
-// If you need to change pins for PWM, SPI, I2C, or Serial communications, be aware that
-// doing this may require changing the driver, channel, PAL (Pin ALternate function) mode,
-// DMA stream, and/or DMA channel.
-
-
-// Bonsai C4 wires up pin A9 for Vbus sensing pin by default. For spilt keyboards, this
-// can be used to determine which half of the keyboard is plugged into USB.
-// For boards using Bonsai C4 merely as a reference design, the VBUS sense pin A9
-// can be used for purposes other than Vbus sensing (e.g. the switch
-// matrix).
-//
-// If A9 is needed for Vbus sensing, uncomment the line
-// below. Most keyboards using Bonsai C4 can leave the line below
-// commented out.
-//
-// #undef BOARD_OTG_NOVBUSSENS
-
-// FRAM configuration
-#define EXTERNAL_EEPROM_SPI_SLAVE_SELECT_PIN A0
-#define EXTERNAL_EEPROM_SPI_CLOCK_DIVISOR 8 // 96MHz / 8 = 12MHz; max supported by MB85R64 is 20MHz
-#define EXTERNAL_EEPROM_PAGE_SIZE 64 // does not matter for FRAM, just sets the RAM buffer size in STM32F chip
-#define DYNAMIC_KEYMAP_EEPROM_MAX_ADDR 8191
-
-// External flash configuration
-#define EXTERNAL_FLASH_SPI_SLAVE_SELECT_PIN B12
-#define EXTERNAL_FLASH_SPI_CLOCK_DIVISOR 1 // 96MHz; max supported by W25Q128JV is 133MHz
-#define EXTERNAL_FLASH_BYTE_COUNT (16 * 1024 * 1024) //128Mbit or 16MByte
-#define EXTERNAL_FLASH_PAGE_SIZE 256
-#define EXTERNAL_FLASH_SPI_TIMEOUT 200000 //datasheet max is 200 seconds for flash chip erase
-
-// SPI Configuration (needed for FRAM and FLASH)
-#define SPI_DRIVER SPID1
-#define SPI_SCK_PIN B3
-#define SPI_MOSI_PIN B5
-#define SPI_MISO_PIN B4
-
-// Example code to set up PWM backlight on pin A6
-// If a different pin is used, a different PWM driver/channel settings may be necessary
-#define BACKLIGHT_PIN A6
-#define BACKLIGHT_PWM_DRIVER PWMD3
-#define BACKLIGHT_PWM_CHANNEL 1
-
-// Example code for WS2812 underglow
-// Only pin A10 is wired to send 5V signals to the WS2812
-// This also usually requires adding special wiring during board assembly
-#define RGB_DI_PIN A10
-#define WS2812_PWM_DRIVER PWMD1
-#define WS2812_PWM_CHANNEL 3
-#define WS2812_PWM_PAL_MODE 1
-#define WS2812_DMA_STREAM STM32_DMA2_STREAM5
-#define WS2812_DMA_CHANNEL 6
diff --git a/keyboards/custommk/bonsai_c4_template/halconf.h b/keyboards/custommk/bonsai_c4_template/halconf.h
deleted file mode 100644
index a90ea163f3..0000000000
--- a/keyboards/custommk/bonsai_c4_template/halconf.h
+++ /dev/null
@@ -1,35 +0,0 @@
-/* Copyright 2021 customMK
- *
- * 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
-
-// If you are using I2C (e.g. for OLED), include this line
-#define HAL_USE_I2C TRUE
-
-// If you are using PWM (e.g. for WS2812, backlight, etc.) include this line
-#define HAL_USE_PWM TRUE
-
-// If you are using serial comms for split communications, include these lines
-#define HAL_USE_SERIAL TRUE
-#define SERIAL_BUFFERS_SIZE 256
-
-// If you are using SPI (e.g. for FRAM, flash, etc.) include these lines
-#define HAL_USE_SPI TRUE
-#define SPI_SELECT_MODE SPI_SELECT_MODE_PAD
-// This enables interrupt-driven mode
-#define SPI_USE_WAIT TRUE
-
-#include_next <halconf.h> \ No newline at end of file
diff --git a/keyboards/custommk/bonsai_c4_template/mcuconf.h b/keyboards/custommk/bonsai_c4_template/mcuconf.h
deleted file mode 100644
index 4f926bd7de..0000000000
--- a/keyboards/custommk/bonsai_c4_template/mcuconf.h
+++ /dev/null
@@ -1,35 +0,0 @@
-/* Copyright 2022 customMK
- *
- * 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>
-
-// Used for underglow in example code
-#undef STM32_PWM_USE_TIM1 //timer 1 channel 3
-#define STM32_PWM_USE_TIM1 TRUE
-
-// Used for backlight in examples
-#undef STM32_PWM_USE_TIM3 //timer 3 channel 1
-#define STM32_PWM_USE_TIM3 TRUE
-
-// Used for FRAM and flash in example code
-#undef STM32_SPI_USE_SPI1
-#define STM32_SPI_USE_SPI1 TRUE
-
-// Used for Split comms in example code
-#undef STM32_SERIAL_USE_USART1
-#define STM32_SERIAL_USE_USART1 TRUE \ No newline at end of file
diff --git a/keyboards/custommk/bonsai_c4_template/readme.md b/keyboards/custommk/bonsai_c4_template/readme.md
deleted file mode 100644
index 0c0fd8ed0c..0000000000
--- a/keyboards/custommk/bonsai_c4_template/readme.md
+++ /dev/null
@@ -1,10 +0,0 @@
-# Bonsai C4 template code
-
-Currently, the converter for Pro Micro to Bonsai C4 only does pin mapping. This is sufficient for simple keyboards and also a good start for
-incorporating into more advanced keyboards with other features (like RGB, OLED, backlighting, split communiciations, etc.). However, to make
-use of the more advanced features--including using the FRAM and flash memory chip included on Bonsai C4--various peripheral hardware must
-be configured. Pro Micro does not requrie such configuration because such functionality is more limited and hard-wired to specific pins.
-
-The code here provides examples that can be used to operate SPI, I2C, PWM, and Serial comms. In addition to using the converter, you will
-need to take code (as-needed) and add it to existing config.h files, or add in new halconf.h and mcuconf.h files. If you are changing which
-pins are used for certain functions, you should verify the new pins support that functionality, and check all assingments to ensure the correct settings are used (including as-applicable driver, channel, PAL (Pin ALternate function) mode, DMA stream, and/or DMA channel).