diff options
| author | Mega Mind <68985133+megamind4089@users.noreply.github.com> | 2022-08-14 19:27:26 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-14 21:27:26 +1000 |
| commit | fce99f38757d7ddbcaada0f5f0157ca24b6162b7 (patch) | |
| tree | 1164212f57f73c9b85d06b3713527ad4809fe735 /docs | |
| parent | ba04ecfabd4f254bb89ccd7d1de9ac7fb228ce5b (diff) | |
[Controller] Added board config for custom controller STeMCell (#16287)
Co-authored-by: Mariappan Ramasamy <947300+Mariappan@users.noreply.github.com>
Co-authored-by: Mariappan Ramasamy <maari@basis-ai.com>
Co-authored-by: Sadek Baroudi <sadekbaroudi@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/feature_converters.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/feature_converters.md b/docs/feature_converters.md index 569cf0f17d..936ab44559 100644 --- a/docs/feature_converters.md +++ b/docs/feature_converters.md | |||
| @@ -15,6 +15,7 @@ Currently the following converters are available: | |||
| 15 | | `promicro` | `promicro_rp2040` | | 15 | | `promicro` | `promicro_rp2040` | |
| 16 | | `promicro` | `blok` | | 16 | | `promicro` | `blok` | |
| 17 | | `promicro` | `bit_c_pro` | | 17 | | `promicro` | `bit_c_pro` | |
| 18 | | `promicro` | `stemcell` | | ||
| 18 | 19 | ||
| 19 | See below for more in depth information on each converter. | 20 | See below for more in depth information on each converter. |
| 20 | 21 | ||
| @@ -56,6 +57,7 @@ If a board currently supported in QMK uses a [Pro Micro](https://www.sparkfun.co | |||
| 56 | | [SparkFun Pro Micro - RP2040](https://www.sparkfun.com/products/18288) | `promicro_rp2040` | | 57 | | [SparkFun Pro Micro - RP2040](https://www.sparkfun.com/products/18288) | `promicro_rp2040` | |
| 57 | | [Blok](https://boardsource.xyz/store/628b95b494dfa308a6581622) | `blok` | | 58 | | [Blok](https://boardsource.xyz/store/628b95b494dfa308a6581622) | `blok` | |
| 58 | | [Bit-C PRO](https://nullbits.co/bit-c-pro) | `bit_c_pro` | | 59 | | [Bit-C PRO](https://nullbits.co/bit-c-pro) | `bit_c_pro` | |
| 60 | | [STeMCell](https://github.com/megamind4089/STeMCell) | `stemcell` | | ||
| 59 | 61 | ||
| 60 | Converter summary: | 62 | Converter summary: |
| 61 | 63 | ||
| @@ -66,6 +68,7 @@ Converter summary: | |||
| 66 | | `promicro_rp2040` | `-e CONVERT_TO=promicro_rp2040` | `CONVERT_TO=promicro_rp2040` | `#ifdef CONVERT_TO_PROMICRO_RP2040` | | 68 | | `promicro_rp2040` | `-e CONVERT_TO=promicro_rp2040` | `CONVERT_TO=promicro_rp2040` | `#ifdef CONVERT_TO_PROMICRO_RP2040` | |
| 67 | | `blok` | `-e CONVERT_TO=blok` | `CONVERT_TO=blok` | `#ifdef CONVERT_TO_BLOK` | | 69 | | `blok` | `-e CONVERT_TO=blok` | `CONVERT_TO=blok` | `#ifdef CONVERT_TO_BLOK` | |
| 68 | | `bit_c_pro` | `-e CONVERT_TO=bit_c_pro` | `CONVERT_TO=bit_c_pro` | `#ifdef CONVERT_TO_BIT_C_PRO` | | 70 | | `bit_c_pro` | `-e CONVERT_TO=bit_c_pro` | `CONVERT_TO=bit_c_pro` | `#ifdef CONVERT_TO_BIT_C_PRO` | |
| 71 | | `stemcell` | `-e CONVERT_TO=stemcell` | `CONVERT_TO=stemcell` | `#ifdef CONVERT_TO_STEMCELL` | | ||
| 69 | 72 | ||
| 70 | ### Proton C :id=proton_c | 73 | ### Proton C :id=proton_c |
| 71 | 74 | ||
| @@ -99,3 +102,22 @@ The following defaults are based on what has been implemented for [RP2040](platf | |||
| 99 | ### SparkFun Pro Micro - RP2040, Blok, and Bit-C PRO :id=promicro_rp2040 | 102 | ### SparkFun Pro Micro - RP2040, Blok, and Bit-C PRO :id=promicro_rp2040 |
| 100 | 103 | ||
| 101 | Currently identical to [Adafruit KB2040](#kb2040). | 104 | Currently identical to [Adafruit KB2040](#kb2040). |
| 105 | |||
| 106 | ### STeMCell :id=stemcell | ||
| 107 | |||
| 108 | Feature set currently identical to [Proton C](#proton_c). | ||
| 109 | There are two versions of STeMCell available, with different pinouts: | ||
| 110 | - v1.0.0 | ||
| 111 | - v2.0.0 (pre-release v1.0.1, v1.0.2) | ||
| 112 | Default official firmware only supports v2.0.0 STeMCell. | ||
| 113 | |||
| 114 | STeMCell has support to swap UART and I2C pins, to enable single-wire uart communication in STM chips. | ||
| 115 | |||
| 116 | The following additional flags has to be used while compiling, based on the pin used for split communication. | ||
| 117 | |||
| 118 | | Split Pin | Compile flags | | ||
| 119 | |-----------|---------------| | ||
| 120 | | D3 | -e STMC_US=yes| | ||
| 121 | | D2 | Not needed | | ||
| 122 | | D1 | -e STMC_IS=yes| | ||
| 123 | | D0 | Not needed | | ||
