docs/i2c_driver.md

   1 # I2C Master Driver
   2
   3 The 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. Returns status of transaction.                                                             |
  12 |`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. |
  13 |`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.                                                                          |
  14 |`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.                                                                         |
  15 |`uint8_t i2c_stop(void);`                                                                                         |Ends an I2C transaction.                                                                                                                                                     |
  16
  17 ### Function Return
  18
  19 All the above functions, except `void i2c_init(void);` return the following truth table:
  20
  21 |Return Value   |Description                                        |
  22 |---------------|---------------------------------------------------|
  23 |0              |Operation executed successfully.                   |
  24 |-1             |Operation failed.                                  |
  25 |-2             |Operation timed out.                               |
  26
  27
  28 ## AVR
  29
  30 ### Configuration
  31
  32 The following defines can be used to configure the I2C master driver.
  33
  34 |Variable          |Description                                        |Default|
  35 |------------------|---------------------------------------------------|-------|
  36 |`F_SCL`           |Clock frequency in Hz                              |400KHz |
  37 |`Prescaler`       |Divides master clock to aid in I2C clock selection |1      |
  38
  39 AVRs usually have set GPIO which turn into I2C pins, therefore no further configuration is required.
  40
  41 ## ARM
  42
  43 For ARM the Chibios I2C HAL driver is under the hood.
  44 This section assumes an STM32 MCU.
  45
  46 ### Configuration
  47
  48 The configuration for ARM MCUs can be quite complex as often there are multiple I2C drivers which can be assigned to a variety of ports.
  49
  50 Firstly the `mcuconf.h` file must be setup to enable the necessary hardware drivers.
  51
  52 |Variable                      |Description                                                                        |Default|
  53 |------------------------------|------------------------------------------------------------------------------------|-------|
  54 |`#STM32_I2C_USE_XXX`          |Enable/Disable the hardware driver XXX (each driver should be explicitly listed)    |FALSE  |
  55 |`#STM32_I2C_BUSY_TIMEOUT`     |Time in ms until the I2C command is aborted if no response is received              |50     |
  56 |`#STM32_I2C_XXX_IRQ_PRIORITY` |Interrupt priority for hardware driver XXX (THIS IS AN EXPERT SETTING)              |10     |
  57 |`#STM32_I2C_USE_DMA`          |Enable/Disable the ability of the MCU to offload the data transfer to the DMA unit  |TRUE   |
  58 |`#STM32_I2C_XXX_DMA_PRIORITY` |Priority of DMA unit for hardware driver XXX (THIS IS AN EXPERT SETTING)            |1      |
  59
  60 Secondly, in the `halconf.h` file, `#define HAL_USE_I2C` must be set to `TRUE`. This allows ChibiOS to load its I2C driver.
  61
  62 Lastly, we need to assign the correct GPIO pins depending on the I2C hardware driver we want to use.
  63
  64 By 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.
  65
  66 STM32 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. You can use these defines to set your i2c pins:
  67
  68 | Variable                 | Description                                                                                  | Default |
  69 |--------------------------|----------------------------------------------------------------------------------------------|---------|
  70 | `I2C1_SCL_BANK`          | The bank of pins (`GPIOA`, `GPIOB`, `GPIOC`) to use for SCL                                  | `GPIOB` |
  71 | `I2C1_SDA_BANK`          | The bank of pins (`GPIOA`, `GPIOB`, `GPIOC`) to use for SDA                                  | `GPIOB` |
  72 | `I2C1_SCL`               | The pin number for the SCL pin (0-9)                                                         | `6`     |
  73 | `I2C1_SDA`               | The pin number for the SDA pin (0-9)                                                         | `7`     |
  74 | `I2C1_BANK` (deprecated) | The bank of pins (`GPIOA`, `GPIOB`, `GPIOC`), superceded by `I2C1_SCL_BANK`, `I2C1_SDA_BANK` | `GPIOB` |
  75
  76 The ChibiOS I2C driver configuration depends on STM32 MCU:
  77
  78     STM32F1xx, STM32F2xx, STM32F4xx, STM32L0xx and STM32L1xx use I2Cv1;
  79     STM32F0xx, STM32F3xx, STM32F7xx and STM32L4xx use I2Cv2;
  80
  81 #### I2Cv1
  82 STM32 MCUs allow for different clock and duty parameters when configuring I2Cv1. These can be modified using the following parameters, using <https://www.playembedded.org/blog/stm32-i2c-chibios/#I2Cv1_configuration_structure> as a reference:
  83
  84 | Variable           | Default          |
  85 |--------------------|------------------|
  86 | `I2C1_OPMODE`      | `OPMODE_I2C`     |
  87 | `I2C1_CLOCK_SPEED` | `100000`         |
  88 | `I2C1_DUTY_CYCLE`  | `STD_DUTY_CYCLE` |
  89
  90 #### I2Cv2
  91 STM32 MCUs allow for different timing parameters when configuring I2Cv2. These can be modified using the following parameters, using <https://www.st.com/en/embedded-software/stsw-stm32126.html> as a reference:
  92
  93 | Variable              | Default |
  94 |-----------------------|---------|
  95 | `I2C1_TIMINGR_PRESC`  | `15U`   |
  96 | `I2C1_TIMINGR_SCLDEL` | `4U`    |
  97 | `I2C1_TIMINGR_SDADEL` | `2U`    |
  98 | `I2C1_TIMINGR_SCLH`   | `15U`   |
  99 | `I2C1_TIMINGR_SCLL`   | `21U`   |
 100
 101 STM32 MCUs allow for different "alternate function" modes when configuring GPIO pins. These are required to switch the pins used to I2Cv2 mode. See the respective datasheet for the appropriate values for your MCU.
 102
 103 | Variable            | Default |
 104 |---------------------|---------|
 105 | `I2C1_SCL_PAL_MODE` | `4`     |
 106 | `I2C1_SDA_PAL_MODE` | `4`     |
 107
 108 #### Other
 109 You can also overload the `void i2c_init(void)` function, which has a weak attribute. If you do this the configuration variables above will not be used. Please consult the datasheet of your MCU for the available GPIO configurations. The following is an example initialization function:
 110
 111 ```C
 112 void i2c_init(void)
 113 {
 114   setPinInput(B6); // Try releasing special pins for a short time
 115   setPinInput(B7);
 116   wait_ms(10); // Wait for the release to happen
 117
 118   palSetPadMode(GPIOB, 6, PAL_MODE_ALTERNATE(4) | PAL_STM32_OTYPE_OPENDRAIN | PAL_STM32_PUPDR_PULLUP); // Set B6 to I2C function
 119   palSetPadMode(GPIOB, 7, PAL_MODE_ALTERNATE(4) | PAL_STM32_OTYPE_OPENDRAIN | PAL_STM32_PUPDR_PULLUP); // Set B7 to I2C function
 120 }
 121 ```