diff options
| author | Joel Challis <git@zvecr.com> | 2021-09-12 15:41:33 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-12 15:41:33 +0100 |
| commit | 0fa217a5b7cdd035105387fd31c506fda4cfb945 (patch) | |
| tree | 1ba0df8f6cb8462fcc3517f7a090ad7c72123038 /docs | |
| parent | bb841087bbd47b0be6dffafa8a4f7a361867f71d (diff) | |
| download | qmk_firmware-0fa217a5b7cdd035105387fd31c506fda4cfb945.tar.gz qmk_firmware-0fa217a5b7cdd035105387fd31c506fda4cfb945.zip | |
Align ChibiOS I2C defs with other drivers (#14399)
* Align ChibiOS I2C defs with other drivers
* Update keyboards/xelus/valor_frl_tkl/config.h
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/i2c_driver.md | 17 | ||||
| -rw-r--r-- | docs/ja/i2c_driver.md | 11 |
2 files changed, 11 insertions, 17 deletions
diff --git a/docs/i2c_driver.md b/docs/i2c_driver.md index 3ec34a0f8..9017b44ed 100644 --- a/docs/i2c_driver.md +++ b/docs/i2c_driver.md | |||
| @@ -62,16 +62,13 @@ Then, modify your board's `mcuconf.h` to enable the peripheral you've chosen, fo | |||
| 62 | 62 | ||
| 63 | Configuration-wise, you'll need to set up the peripheral as per your MCU's datasheet -- the defaults match the pins for a Proton-C, i.e. STM32F303. | 63 | Configuration-wise, you'll need to set up the peripheral as per your MCU's datasheet -- the defaults match the pins for a Proton-C, i.e. STM32F303. |
| 64 | 64 | ||
| 65 | |`config.h` Overrride |Description |Default| | 65 | |`config.h` Overrride |Description |Default| |
| 66 | |------------------------|-------------------------------------------------------------------------------------------|-------| | 66 | |------------------------|--------------------------------------------------------------|-------| |
| 67 | |`I2C_DRIVER` |I2C peripheral to use - I2C1 -> `I2CD1`, I2C2 -> `I2CD2` etc. |`I2CD1`| | 67 | |`I2C_DRIVER` |I2C peripheral to use - I2C1 -> `I2CD1`, I2C2 -> `I2CD2` etc. |`I2CD1`| |
| 68 | |`I2C1_BANK` (deprecated)|The bank of pins (`GPIOA`, `GPIOB`, `GPIOC`), superseded by `I2C1_SCL_BANK`/`I2C1_SDA_BANK`|`GPIOB`| | 68 | |`I2C1_SCL_PIN` |The pin definition for SCL |`B6` | |
| 69 | |`I2C1_SCL_BANK` |The bank of pins (`GPIOA`, `GPIOB`, `GPIOC`) to use for SCL |`GPIOB`| | 69 | |`I2C1_SCL_PAL_MODE` |The alternate function mode for SCL |`4` | |
| 70 | |`I2C1_SCL` |The pin number for SCL (0-15) |`6` | | 70 | |`I2C1_SDA_PIN` |The pin definition for SDA |`B7` | |
| 71 | |`I2C1_SCL_PAL_MODE` |The alternate function mode for SCL |`4` | | 71 | |`I2C1_SDA_PAL_MODE` |The alternate function mode for SDA |`4` | |
| 72 | |`I2C1_SDA_BANK` |The bank of pins (`GPIOA`, `GPIOB`, `GPIOC`) to use for SDA |`GPIOB`| | ||
| 73 | |`I2C1_SDA` |The pin number for SDA (0-15) |`7` | | ||
| 74 | |`I2C1_SDA_PAL_MODE` |The alternate function mode for SDA |`4` | | ||
| 75 | 72 | ||
| 76 | The following configuration values depend on the specific MCU in use. | 73 | The following configuration values depend on the specific MCU in use. |
| 77 | 74 | ||
diff --git a/docs/ja/i2c_driver.md b/docs/ja/i2c_driver.md index 9d348d580..1d8f70e16 100644 --- a/docs/ja/i2c_driver.md +++ b/docs/ja/i2c_driver.md | |||
| @@ -79,13 +79,10 @@ ARM MCU 用の設定はしばしば非常に複雑です。これは、多くの | |||
| 79 | 79 | ||
| 80 | STM32 MCU では、使用するハードウェアドライバにより、さまざまなピンを I2C ピンとして設定できます。標準では `B6`, `B7` ピンが I2C 用のピンです。 I2C 用のピンを設定するために次の定義が使えます： | 80 | STM32 MCU では、使用するハードウェアドライバにより、さまざまなピンを I2C ピンとして設定できます。標準では `B6`, `B7` ピンが I2C 用のピンです。 I2C 用のピンを設定するために次の定義が使えます： |
| 81 | 81 | ||
| 82 | | 変数 | 説明 | 既定値 | | 82 | | 変数 | 説明 | 既定値 | |
| 83 | |-----------------------|--------------------------------------------------------------------------------------------------|---------| | 83 | |-----------------------|-------------------------------------------------------------------------------------------|---------| |
| 84 | | `I2C1_SCL_BANK` | SCL に使うピンのバンク (`GPIOA`, `GPIOB`, `GPIOC`) | `GPIOB` | | 84 | | `I2C1_SCL_PIN` | SCL のピン番号 | `B6` | |
| 85 | | `I2C1_SDA_BANK` | SDA に使うピンのバンク (`GPIOA`, `GPIOB`, `GPIOC`) | `GPIOB` | | 85 | | `I2C1_SDA_PIN` | SDA のピン番号 | `B7` | |
| 86 | | `I2C1_SCL` | SCL のピン番号 (0-15) | `6` | | ||
| 87 | | `I2C1_SDA` | SDA のピン番号 (0-15) | `7` | | ||
| 88 | | `I2C1_BANK`（非推奨） | 使用するピンのバンク (`GPIOA`, `GPIOB`, `GPIOC`)。後継は `I2C1_SCL_BANK`, `I2C1_SDA_BANK` です。 | `GPIOB` | | ||
| 89 | 86 | ||
| 90 | ChibiOS I2C ドライバの設定項目は STM32 MCU の種類に依存します。 | 87 | ChibiOS I2C ドライバの設定項目は STM32 MCU の種類に依存します。 |
| 91 | 88 | ||