aboutsummaryrefslogtreecommitdiff
path: root/docs/i2c_driver.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/i2c_driver.md')
-rw-r--r--docs/i2c_driver.md83
1 files changed, 83 insertions, 0 deletions
diff --git a/docs/i2c_driver.md b/docs/i2c_driver.md
new file mode 100644
index 000000000..f69eb5a9d
--- /dev/null
+++ b/docs/i2c_driver.md
@@ -0,0 +1,83 @@
1# I2C Master Driver
2
3The I2C Master drivers used in QMK have a set of common functions to allow portability between MCUs.
4
5## Available functions
6
7|Function |Description |
8|------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
9|`void i2c_init(void);` |Initializes the I2C driver. This function should be called once before any transaction is initiated. |
10|`uint8_t i2c_start(uint8_t address);` |Starts an I2C transaction. Address is the 7-bit slave address without the direction bit. |
11|`uint8_t i2c_transmit(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout);` |Transmit data over I2C. Address is the 7-bit slave address without the direction. |
12|`uint8_t i2c_transmit(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout);` |Transmit data over I2C. Address is the 7-bit slave address without the direction. Returns status of transaction. |
13|`uint8_t i2c_receive(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout);` |Receive data over I2C. Address is the 7-bit slave address without the direction. Saves number of bytes specified by `length` in `data` array. Returns status of transaction. |
14|`uint8_t i2c_writeReg(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout);` |Same as the `i2c_transmit` function but `regaddr` sets where in the slave the data will be written. |
15|`uint8_t i2c_readReg(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout);` |Same as the `i2c_receive` function but `regaddr` sets from where in the slave the data will be read. |
16|`uint8_t i2c_stop(uint16_t timeout);` |Stops the I2C driver. |
17
18### Function Return
19
20All the above functions, except `void i2c_init(void);` return the following truth table:
21
22|Return Value |Description |
23|---------------|---------------------------------------------------|
24|0 |Operation executed successfully. |
25|-1 |Operation failed. |
26|-2 |Operation timed out. |
27
28
29## AVR
30
31### Configuration
32
33The following defines can be used to configure the I2C master driver.
34
35|Variable |Description |Default|
36|------------------|---------------------------------------------------|-------|
37|`#F_SCL` |Clock frequency in Hz |400KHz |
38|`#Prescaler` |Divides master clock to aid in I2C clock selection |1 |
39
40AVRs usually have set GPIO which turn into I2C pins, therefore no further configuration is required.
41
42## ARM
43
44For ARM the Chibios I2C HAL driver is under the hood.
45This section assumes an STM32 MCU.
46
47### Configuration
48
49The configuration for ARM MCUs can be quite complex as often there are multiple I2C drivers which can be assigned to a variety of ports.
50
51Firstly the `mcuconf.h` file must be setup to enable the necessary hardware drivers.
52
53|Variable |Description |Default|
54|------------------------------|------------------------------------------------------------------------------------|-------|
55|`#STM32_I2C_USE_XXX` |Enable/Disable the hardware driver XXX (each driver should be explicitly listed) |FALSE |
56|`#STM32_I2C_BUSY_TIMEOUT` |Time in ms until the I2C command is aborted if no response is received |50 |
57|`#STM32_I2C_XXX_IRQ_PRIORITY` |Interrupt priority for hardware driver XXX (THIS IS AN EXPERT SETTING) |10 |
58|`#STM32_I2C_USE_DMA` |Enable/Disable the ability of the MCU to offload the data transfer to the DMA unit |TRUE |
59|`#STM32_I2C_XXX_DMA_PRIORITY` |Priority of DMA unit for hardware driver XXX (THIS IS AN EXPERT SETTING) |1 |
60
61Secondly, in the `halconf.h` file, `#define HAL_USE_I2C` must be set to `TRUE`. This allows ChibiOS to load its I2C driver.
62
63Lastly, we need to assign the correct GPIO pins depending on the I2C hardware driver we want to use.
64
65By default the I2C1 hardware driver is assumed to be used. If another hardware driver is used, `#define I2C_DRIVER I2CDX` should be added to the `config.h` file with X being the number of hardware driver used. For example is I2C3 is enabled, the `config.h` file should contain `#define I2C_DRIVER I2CD3`. This aligns the QMK I2C driver with the Chibios I2C driver.
66
67STM32 MCUs allows a variety of pins to be configured as I2C pins depending on the hardware driver used. By default B6 and B7 are set to I2C.
68
69This can be changed by declaring the `i2c_init` function which intentionally has a weak attribute. Please consult the datasheet of your MCU for the available GPIO configurations. The following is an example initialization function:
70
71```C
72void i2c_init(void)
73{
74 setPinInput(B6); // Try releasing special pins for a short time
75 setPinInput(B7);
76 chThdSleepMilliseconds(10); // Wait for the release to happen
77
78 palSetPadMode(GPIOB, 6, PAL_MODE_ALTERNATE(4) | PAL_STM32_OTYPE_OPENDRAIN | PAL_STM32_PUPDR_PULLUP); // Set B6 to I2C function
79 palSetPadMode(GPIOB, 7, PAL_MODE_ALTERNATE(4) | PAL_STM32_OTYPE_OPENDRAIN | PAL_STM32_PUPDR_PULLUP); // Set B7 to I2C function
80}
81```
82
83
generated by cgit v1.2.3 (git 2.25.1) at 2025-11-25 21:31:39 +0000