diff options
Diffstat (limited to 'docs/i2c_driver.md')
-rw-r--r-- | docs/i2c_driver.md | 17 |
1 files changed, 7 insertions, 10 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 | ||